Skip to content

Commit

Permalink
Update how-to-open-a-file.rst
Browse files Browse the repository at this point in the history
Clarify that "open" is an alias of class Document.

Addresses issue #3636.
  • Loading branch information
JorjMcKie committed Jul 1, 2024
1 parent ab62495 commit bf8c7ec
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/how-to-open-a-file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ To open a file, do the following:
doc = pymupdf.open("a.pdf")
.. note:: The above creates a :ref:`Document`. The instruction `doc = pymupdf.Document("a.pdf")` does exactly the same. So, `open` is just a convenient alias and you can find its full API documented in that chapter.


Opening with :index:`a Wrong File Extension <pair: wrong; file extension>`
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Expand Down

0 comments on commit bf8c7ec

Please sign in to comment.