-
-
Notifications
You must be signed in to change notification settings - Fork 8
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.
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
fix issue where passing two styles would fail with index error #162
Draft
jspaezp
wants to merge
5
commits into
DanielNoord:main
Choose a base branch
from
jspaezp:bugfix/empty_section
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
9abad26
fix issue where passing two styles would fail with index error
jspaezp 0c6795b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 903c95f
Update pydocstringformatter/_formatting/base.py
jspaezp c245c03
handled empty section name whitespaces
jspaezp edf4976
Merge branch 'main' into bugfix/empty_section
jspaezp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
tests/data/format/multi_style/numpydoc_parameter_spacing.args
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
--style=numpydoc | ||
--style=pep257 |
63 changes: 63 additions & 0 deletions
63
tests/data/format/multi_style/numpydoc_parameter_spacing.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
"""Example module for numpydoc docstring style. | ||
References | ||
----- | ||
NumPy docstring style guide: | ||
https://numpydoc.readthedocs.io/en/latest/format.html#documenting-modules""" | ||
import math | ||
|
||
EULER_NUMBER = math.e | ||
"""Euler's number. | ||
|
||
Not related to Euler's constant (sometimes called the Euler-Mascheroni | ||
constant. | ||
References | ||
----- | ||
E (mathematical constant) | ||
https://en.wikipedia.org/wiki/E_(mathematical_constant) | ||
Notes | ||
--- | ||
It is the limit of ``(1 + 1/n)**n`` as n approaches infinity, so it | ||
is used in the equation for continuously-compouned interest. | ||
|
||
It is also the sum of the reciprocals of the whole numbers starting | ||
with zero, which is related to some calculus-related properties | ||
mathemeticians find elegant. | ||
""" | ||
|
||
|
||
def sincos(theta): | ||
"""Returns | ||
---- | ||
sin: float | ||
the sine of theta | ||
cos: float | ||
the cosine of theta | ||
Raises | ||
--- | ||
TypeError | ||
If `theta` is not a float. | ||
Parameters | ||
----- | ||
theta: float | ||
the angle at which to calculate the sine and cosine. | ||
""" | ||
return math.sin(theta), math.cos(theta) | ||
|
||
|
||
def fibbonacci(): | ||
"""Generate the Fibonacci sequence. | ||
|
||
Each term is the sum of the two previous; conventionally starts | ||
with two ones. | ||
References | ||
----- | ||
Fibonacci numbers | ||
https://en.wikipedia.org/wiki/Fibonacci_number | ||
Yields | ||
--- | ||
int""" | ||
curr = 1 | ||
last = 0 | ||
while True: | ||
yield curr | ||
curr, last = curr + last, curr |
74 changes: 74 additions & 0 deletions
74
tests/data/format/multi_style/numpydoc_parameter_spacing.py.out
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
"""Example module for numpydoc docstring style. | ||
|
||
References | ||
---------- | ||
NumPy docstring style guide: | ||
https://numpydoc.readthedocs.io/en/latest/format.html#documenting-modules | ||
""" | ||
import math | ||
|
||
EULER_NUMBER = math.e | ||
"""Euler's number. | ||
|
||
Not related to Euler's constant (sometimes called the Euler-Mascheroni | ||
constant. | ||
|
||
Notes | ||
----- | ||
It is the limit of ``(1 + 1/n)**n`` as n approaches infinity, so it | ||
is used in the equation for continuously-compouned interest. | ||
|
||
It is also the sum of the reciprocals of the whole numbers starting | ||
with zero, which is related to some calculus-related properties | ||
mathemeticians find elegant. | ||
|
||
References | ||
---------- | ||
E (mathematical constant) | ||
https://en.wikipedia.org/wiki/E_(mathematical_constant) | ||
""" | ||
|
||
|
||
def sincos(theta): | ||
"""Returns. | ||
|
||
Parameters | ||
---------- | ||
theta : float | ||
the angle at which to calculate the sine and cosine. | ||
|
||
Raises | ||
------ | ||
TypeError | ||
If `theta` is not a float. | ||
|
||
|
||
---- | ||
sin: float | ||
the sine of theta | ||
cos: float | ||
the cosine of theta | ||
""" | ||
return math.sin(theta), math.cos(theta) | ||
|
||
|
||
def fibbonacci(): | ||
"""Generate the Fibonacci sequence. | ||
|
||
Each term is the sum of the two previous; conventionally starts | ||
with two ones. | ||
|
||
Yields | ||
------ | ||
int | ||
|
||
References | ||
---------- | ||
Fibonacci numbers | ||
https://en.wikipedia.org/wiki/Fibonacci_number | ||
""" | ||
curr = 1 | ||
last = 0 | ||
while True: | ||
yield curr | ||
curr, last = curr + last, curr |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh this is becoming more difficult than I hoped. It seems both styles are somewhat incompatible with each other. This is the missing section name, which is now being used as a summary/title...
I'll have to think about this. Perhaps we should fix this in another PR, but I like to check if this is easily fixable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well ... if you believe that the issue is that the styles are mutually exclusive in some instances, enforcing that is not hard internally.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the issue that they are currently mutually exclusive. Perhaps we can fix this by changing the order in which formatters are called. I hope to have time somewhere this week to look into this.