[geany/geany-plugins] ee3214: Fix some docs in the document module

[Paris Liakos]

Branch:      refs/heads/master
Author:      Paris Liakos <rootatwc at gmail.com>
Committer:   Matthew Brush <matt at geany.org>
Date:        Fri, 14 Mar 2014 03:44:32 UTC
Commit:      ee32140cd8183a1307cb02a88b562abc026017ce
             https://github.com/geany/geany-plugins/commit/ee32140cd8183a1307cb02a88b562abc026017ce

Log Message:
-----------
Fix some docs in the document module

Signed-off-by: Matthew Brush <matt at geany.org>


Modified Paths:
--------------
    geanypy/doc/source/document.rst

Modified: geanypy/doc/source/document.rst
8 files changed, 4 insertions(+), 4 deletions(-)
===================================================================
@@ -30,7 +30,7 @@ functions are used for creating instances of the :class:`Document` object.
 
     :return: A :class:`Document` instance for the corresponding document or :data:`None` if no document matched.
 
-.. function:: get_from_index(index)
+.. function:: index(index)
 
     Gets a document based on its index in Geany's documents array.
 
@@ -38,7 +38,7 @@ functions are used for creating instances of the :class:`Document` object.
 
     :return: A :class:`Document` instance for the corresponding document or :data:`None` if not document matched, or the document that matched isn't valid.
 
-.. function:: new([filename=None[, filetype=None[, text=None]]])
+.. function:: new_file([filename=None[, filetype=None[, text=None]]])
 
     Creates a document file.
 
@@ -48,7 +48,7 @@ functions are used for creating instances of the :class:`Document` object.
 
     :return: A :class:`Document` instance for the new document.
 
-.. function:: open(filename[, read_only=False[, filetype=None[, forced_enc=None]]])
+.. function:: open_file(filename[, read_only=False[, filetype=None[, forced_enc=None]]])
 
     Open an existing document file.
 
@@ -61,7 +61,7 @@ functions are used for creating instances of the :class:`Document` object.
 
 .. function:: open_files(filenames, read_only=False, filetype="", forced_enc="")
 
-    Open multiple files.  This actually calls :func:`open` once for each filename in `filenames`.
+    Open multiple files.  This actually calls :func:`open_file` once for each filename in `filenames`.
 
     :param filenames: List of filenames to open.
     :param read_only: Whether to open the document in read-only mode.



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).