Fixed the documentation of find_doc() to describe the real rules.

This commit is contained in:
依瑪貓 2017-05-16 10:03:03 +08:00
parent eee95edee7
commit 00a66dffa1

View File

@ -295,11 +295,10 @@ def find_doc(oo, target):
target: A partial path of the document. target: A partial path of the document.
Returns: Returns:
If there is only one opened document, it is returned. If If there is only one opened document that matches the
there are more than one opened document, the document whose target, it is returned. If the target is not specified,
file path matches the "target" is returned. Otherwise, if but there is only one opened document, it is returned.
no matching document or more than one matching document are Otherwise, the program exits with an error.
found, the program exists with an error.
""" """
# Checks the opened documents # Checks the opened documents
enum = oo.desktop.getComponents().createEnumeration() enum = oo.desktop.getComponents().createEnumeration()