Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify future arguments #168

Merged
merged 1 commit into from
Mar 3, 2023
Merged

docs: clarify future arguments #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions docs/source/requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,14 +232,6 @@ with *convention* requirements.
the opening quotes in a multi-line docstring. See requirement
PEP_257_5.2.

The following are new arguments that are needed to implement **should** or
**may** *convention* requirements:
::

--wrap-one-line [boolean, default False]
Boolean to indicate whether to wrap one-line docstrings. Provides
option for requirement PEP_257_4.1.

``docformatter`` currently provides these arguments for *style* requirements.
::

Expand Down Expand Up @@ -270,14 +262,6 @@ The following are new arguments that are needed to implement **should** or
Wrap long one-line docstrings and summary lines in multi-line
docstrings at this length.

The following are new *style* arguments needed to accommodate the various style options:
::

--syntax [string, default "sphinx"]
One of sphinx, numpy, or google
--black [boolean, default False]
Formats docstrings to be compatible with black.

``docformatter`` currently provides these arguments for *stakeholder* requirements.
::

Expand All @@ -299,6 +283,25 @@ The following are new *style* arguments needed to accommodate the various style
--recursive
Drill down directories recursively.

Arguments Needed for Future Releases
------------------------------------

The following are new arguments that are needed to implement **should** or
**may** *convention* requirements:
::

--wrap-one-line [boolean, default False]
Boolean to indicate whether to wrap one-line docstrings. Provides
option for requirement PEP_257_4.1.

The following are new *style* arguments needed to accommodate the various style options:
::

--syntax [string, default "sphinx"]
One of sphinx, numpy, or google
--black [boolean, default False]
Formats docstrings to be compatible with black.

Issue and Version Management
----------------------------

Expand Down
2 changes: 1 addition & 1 deletion src/docformatter/__pkginfo__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@
# SOFTWARE.
"""Package information for docformatter."""

__version__ = "1.5.0"
__version__ = "1.5.1"