From 29b20ff74268abdc3cd634a276c9ac378b417403 Mon Sep 17 00:00:00 2001 From: Louis Maddox Date: Sun, 18 Jul 2021 18:48:50 +0100 Subject: [PATCH] Improve sphinx.project docstrings --- sphinx/project.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sphinx/project.py b/sphinx/project.py index d4293cdc4..6b31e5cba 100644 --- a/sphinx/project.py +++ b/sphinx/project.py @@ -22,7 +22,7 @@ EXCLUDE_PATHS = ['**/_sources', '.#*', '**/.#*', '*.lproj/**'] class Project: - """A project is source code set of Sphinx document.""" + """A project is the source code set of the Sphinx document(s).""" def __init__(self, srcdir: str, source_suffix: Dict[str, str]) -> None: #: Source directory. @@ -61,7 +61,7 @@ class Project: return self.docnames def path2doc(self, filename: str) -> Optional[str]: - """Return the docname for the filename if the file is document. + """Return the docname for the filename if the file is a document. *filename* should be absolute or relative to the source directory. """