Skip to content

Commit

Permalink
Fix docstring of FullRepoManager (#750)
Browse files Browse the repository at this point in the history
The render error originates from how we violate the syntax rules of the `field list` markup element of reStructuredText. The `specification of field list states](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists) that a multi-line `field body` must be indented relative to the `field marker`.
  • Loading branch information
MapleCCC authored Aug 17, 2022
1 parent 2bd6a64 commit 73cfc7f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions libcst/metadata/full_repo_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ def __init__(
:param paths: a collection of paths to access full repository data.
:param providers: a collection of metadata provider classes require accessing full repository data, currently supports
:class:`~libcst.metadata.TypeInferenceProvider` and
:class:`~libcst.metadata.FullyQualifiedNameProvider`.
:class:`~libcst.metadata.TypeInferenceProvider` and
:class:`~libcst.metadata.FullyQualifiedNameProvider`.
:param timeout: number of seconds. Raises `TimeoutExpired <https://docs.python.org/3/library/subprocess.html#subprocess.TimeoutExpired>`_
when timeout.
"""
Expand Down

0 comments on commit 73cfc7f

Please sign in to comment.