Skip to content

docs/ src/__init__.py: improve docs for insert_textbox() methods.#4938

Merged
julian-smith-artifex-com merged 1 commit intomainfrom
jules
Mar 12, 2026
Merged

docs/ src/__init__.py: improve docs for insert_textbox() methods.#4938
julian-smith-artifex-com merged 1 commit intomainfrom
jules

Conversation

@julian-smith-artifex-com
Copy link
Collaborator

@julian-smith-artifex-com julian-smith-artifex-com commented Mar 12, 2026

[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.

Describe <overlay> explicitly because not in Shape.insert_textbox().

Fixed args to match the code:
* Removed <charwidths>.
* Removed <idx>.
* Added <lineheight>.
* Added <set_simple>.

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>.
@julian-smith-artifex-com julian-smith-artifex-com merged commit e21f733 into main Mar 12, 2026
3 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Mar 12, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants