docs/ src/__init__.py: improve docs for insert_textbox() methods.#4938
Merged
julian-smith-artifex-com merged 1 commit intomainfrom Mar 12, 2026
Merged
docs/ src/__init__.py: improve docs for insert_textbox() methods.#4938julian-smith-artifex-com merged 1 commit intomainfrom
julian-smith-artifex-com merged 1 commit intomainfrom
Conversation
src/__init__.py:
In Page.insert_textbox() and Shape.insert_textbox(), sort args to simplify
comparison.
docs/shape.rst::insert_textbox():
Use sorted multiple lines for args to simplify comparison.
docs/page.rst:insert_textbox():
Use sorted multiple lines for args to simplify comparison.
Describe <overlay> explicitly because not in Shape.insert_textbox().
Fixed args to match the code:
* Removed <charwidths>.
* Removed <idx>.
* Added <lineheight>.
* Added <set_simple>.
jamie-lemon
approved these changes
Mar 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[This was prompted by someone on #pymupdf who pointed out that our docs don't agree with our code for
Page/Shape.insert_textbox().]src/init.py:
In Page.insert_textbox() and Shape.insert_textbox(), sort args to simplify
comparison.
docs/shape.rst::insert_textbox():
Use sorted multiple lines for args to simplify comparison.
docs/page.rst:insert_textbox():
Use sorted multiple lines for args to simplify comparison.