diff options
author | Louis Maddox <lmmx@users.noreply.github.com> | 2021-07-19 00:03:11 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-19 00:03:11 +0100 |
commit | 490a4900e8d3494aaec4d9dea69defc0525d1df4 (patch) | |
tree | 31cf85c4723807e2302c04840bd28be90d58b256 /sphinx/ext/autodoc/directive.py | |
parent | b81ad1c1549fb8af023347d6c055b6c94e9bbeb4 (diff) | |
download | sphinx-git-490a4900e8d3494aaec4d9dea69defc0525d1df4.tar.gz |
Fix warning typo; improve sphinx.ext.autodoc docstrings
Diffstat (limited to 'sphinx/ext/autodoc/directive.py')
-rw-r--r-- | sphinx/ext/autodoc/directive.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index a554adf68..2cb2fbabd 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -61,7 +61,7 @@ class DocumenterBridge: self.state = state def warn(self, msg: str) -> None: - warnings.warn('DocumenterBridge.warn is deprecated. Plase use sphinx.util.logging ' + warnings.warn('DocumenterBridge.warn is deprecated. Please use sphinx.util.logging ' 'module instead.', RemovedInSphinx60Warning, stacklevel=2) logger.warning(msg, location=(self.env.docname, self.lineno)) @@ -107,7 +107,7 @@ def process_documenter_options(documenter: Type[Documenter], config: Config, opt def parse_generated_content(state: RSTState, content: StringList, documenter: Documenter ) -> List[Node]: - """Parse a generated content by Documenter.""" + """Parse an item of content generated by Documenter.""" with switch_source_input(state, content): if documenter.titles_allowed: node: Element = nodes.section() @@ -125,8 +125,8 @@ def parse_generated_content(state: RSTState, content: StringList, documenter: Do class AutodocDirective(SphinxDirective): """A directive class for all autodoc directives. It works as a dispatcher of Documenters. - It invokes a Documenter on running. After the processing, it parses and returns - the generated content by Documenter. + It invokes a Documenter upon running. After the processing, it parses and returns + the content generated by Documenter. """ option_spec = DummyOptionSpec() has_content = True |