PyMuPDF
PyMuPDF copied to clipboard
Fix typos on documentation
method page.getTex() does not exist in the example.
use of the :meth:
sphinx syntax produces a paranthesis at the end, rendering :meth:Page.get_text("words")
like Page.get_text("words")()
.
Consider swapping meth
with const
to keep consistent rendering format, or remove the value passed into the method.
According to https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-py-method :const:
is Reference a “defined” constant. This may be a Python variable that is not intended to be changed., which doesn't seem right.
So rather than:
This script uses :const:`Page.get_text("words")` to look for a string
perhaps we should just do:
This script uses ``Page.get_text("words")`` to look for a string
?
That probably works better. Updated the branch with a new commit.
Thanks for this. Could you squash the two commits into one? Then it should be ok to merge it.
Happy to help :) commits are squashed under c5cac2e
The commit message "Update method highlighting with an example input value" seems wrong - could you change back to "Fix typos on documentation"?
commit message amended as suggested
Thanks, now merged.