PyMuPDF icon indicating copy to clipboard operation
PyMuPDF copied to clipboard

Fix typos on documentation

Open 10ego opened this issue 2 years ago • 5 comments

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.

10ego avatar Aug 30 '22 19:08 10ego

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.

10ego avatar Sep 21 '22 15:09 10ego

Thanks for this. Could you squash the two commits into one? Then it should be ok to merge it.

cgdae avatar Sep 21 '22 16:09 cgdae

Happy to help :) commits are squashed under c5cac2e

10ego avatar Sep 21 '22 18:09 10ego

The commit message "Update method highlighting with an example input value" seems wrong - could you change back to "Fix typos on documentation"?

cgdae avatar Sep 22 '22 10:09 cgdae

commit message amended as suggested

10ego avatar Oct 11 '22 18:10 10ego

Thanks, now merged.