Skip to content

Commit 822a19b

Browse files
committed
Fix some docs in the document module
1 parent 3af86f8 commit 822a19b

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/source/document.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ functions are used for creating instances of the :class:`Document` object.
3030

3131
:return: A :class:`Document` instance for the corresponding document or :data:`None` if no document matched.
3232

33-
.. function:: get_from_index(index)
33+
.. function:: index(index)
3434

3535
Gets a document based on its index in Geany's documents array.
3636

3737
:param index: The index of the document in Geany's documents array.
3838

3939
:return: A :class:`Document` instance for the corresponding document or :data:`None` if not document matched, or the document that matched isn't valid.
4040

41-
.. function:: new([filename=None[, filetype=None[, text=None]]])
41+
.. function:: new_file([filename=None[, filetype=None[, text=None]]])
4242

4343
Creates a document file.
4444

@@ -48,7 +48,7 @@ functions are used for creating instances of the :class:`Document` object.
4848

4949
:return: A :class:`Document` instance for the new document.
5050

51-
.. function:: open(filename[, read_only=False[, filetype=None[, forced_enc=None]]])
51+
.. function:: open_file(filename[, read_only=False[, filetype=None[, forced_enc=None]]])
5252

5353
Open an existing document file.
5454

@@ -61,7 +61,7 @@ functions are used for creating instances of the :class:`Document` object.
6161

6262
.. function:: open_files(filenames, read_only=False, filetype="", forced_enc="")
6363

64-
Open multiple files. This actually calls :func:`open` once for each filename in `filenames`.
64+
Open multiple files. This actually calls :func:`open_file` once for each filename in `filenames`.
6565

6666
:param filenames: List of filenames to open.
6767
:param read_only: Whether to open the document in read-only mode.

0 commit comments

Comments
 (0)