Skip to content

Fix adding whitespaces in numpydoc style to single line docstrings #158

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

Merged
merged 2 commits into from
Sep 8, 2022
Merged

Fix adding whitespaces in numpydoc style to single line docstrings #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0df7f29
Fix adding whitespaces in ``numpydoc`` style to single line docstrings
DanielNoord Sep 8, 2022
24668b7
Update docs
DanielNoord Sep 8, 2022
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
40 changes: 20 additions & 20 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ Current usage of ``pydocstringformatter``:
[--style {pep257,numpydoc} [{pep257,numpydoc} ...]]
[--strip-whitespaces --no-strip-whitespaces]
[--split-summary-body --no-split-summary-body]
[--numpydoc-section-order --no-numpydoc-section-order]
[--numpydoc-name-type-spacing --no-numpydoc-name-type-spacing]
[--numpydoc-section-spacing --no-numpydoc-section-spacing]
[--numpydoc-section-hyphen-length --no-numpydoc-section-hyphen-length]
[--linewrap-full-docstring --no-linewrap-full-docstring]
[--beginning-quotes --no-beginning-quotes]
[--closing-quotes --no-closing-quotes]
[--capitalize-first-letter --no-capitalize-first-letter]
[--final-period --no-final-period]
[--quotes-type --no-quotes-type]
[--numpydoc-section-order --no-numpydoc-section-order]
[--numpydoc-name-type-spacing --no-numpydoc-name-type-spacing]
[--numpydoc-section-spacing --no-numpydoc-section-spacing]
[--numpydoc-section-hyphen-length --no-numpydoc-section-hyphen-length]
[files ...]

positional arguments:
Expand Down Expand Up @@ -66,6 +66,22 @@ Current usage of ``pydocstringformatter``:
max length. The maximum length of a summary can be set
with the --max-summary-lines option. Styles: pep257.
(default: True)
--numpydoc-section-order, --no-numpydoc-section-order
Activate or deactivate numpydoc-section-order: Change
section order to match numpydoc guidelines. Styles:
numpydoc. (default: True)
--numpydoc-name-type-spacing, --no-numpydoc-name-type-spacing
Activate or deactivate numpydoc-name-type-spacing:
Ensure proper spacing around the colon separating
names from types. Styles: numpydoc. (default: True)
--numpydoc-section-spacing, --no-numpydoc-section-spacing
Activate or deactivate numpydoc-section-spacing:
Ensure proper spacing between sections. Styles:
numpydoc. (default: True)
--numpydoc-section-hyphen-length, --no-numpydoc-section-hyphen-length
Activate or deactivate numpydoc-section-hyphen-length:
Ensure hyphens after section header lines are proper
length. Styles: numpydoc. (default: True)
--beginning-quotes, --no-beginning-quotes
Activate or deactivate beginning-quotes: Fix the
position of the opening quotes. Styles: default.
Expand All @@ -86,22 +102,6 @@ Current usage of ``pydocstringformatter``:
Activate or deactivate quotes-type: Change all opening
and closing quotes to be triple quotes. Styles:
default. (default: True)
--numpydoc-section-order, --no-numpydoc-section-order
Activate or deactivate numpydoc-section-order: Change
section order to match numpydoc guidelines. Styles:
numpydoc. (default: True)
--numpydoc-name-type-spacing, --no-numpydoc-name-type-spacing
Activate or deactivate numpydoc-name-type-spacing:
Ensure proper spacing around the colon separating
names from types. Styles: numpydoc. (default: True)
--numpydoc-section-spacing, --no-numpydoc-section-spacing
Activate or deactivate numpydoc-section-spacing:
Ensure proper spacing between sections. Styles:
numpydoc. (default: True)
--numpydoc-section-hyphen-length, --no-numpydoc-section-hyphen-length
Activate or deactivate numpydoc-section-hyphen-length:
Ensure hyphens after section header lines are proper
length. Styles: numpydoc. (default: True)

optional formatters:
these formatters are turned off by default
Expand Down
8 changes: 4 additions & 4 deletions pydocstringformatter/_formatting/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@
FORMATTERS: list[Formatter] = [
StripWhitespacesFormatter(),
SplitSummaryAndDocstringFormatter(),
NumpydocSectionOrderingFormatter(),
NumpydocNameColonTypeFormatter(),
NumpydocSectionSpacingFormatter(),
NumpydocSectionHyphenLengthFormatter(),
LineWrapperFormatter(),
BeginningQuotesFormatter(),
ClosingQuotesFormatter(),
CapitalizeFirstLetterFormatter(),
FinalPeriodFormatter(),
QuotesTypeFormatter(),
NumpydocSectionOrderingFormatter(),
NumpydocNameColonTypeFormatter(),
NumpydocSectionSpacingFormatter(),
NumpydocSectionHyphenLengthFormatter(),
]
1 change: 1 addition & 0 deletions tests/data/format/numpydoc/numpydoc_regression.args
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--style=numpydoc
3 changes: 3 additions & 0 deletions tests/data/format/numpydoc/numpydoc_regression.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
def func():
"""
A docstring"""
2 changes: 2 additions & 0 deletions tests/data/format/numpydoc/numpydoc_regression.py.out
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def func():
"""A docstring."""