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.

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
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 1 addition & 1 deletion pydocstringformatter/_formatting/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ def treat_string(
if first_section:
section[0] = section[0].lstrip()
first_section = False
elif not section[0][0].isspace():
elif len(section[0]) > 0 and not section[0][0].isspace():
jspaezp marked this conversation as resolved.
Show resolved Hide resolved
section[0] = f"{' ' * indent_length:s}{section[0]:s}"

# Rejoin sections
Expand Down
2 changes: 2 additions & 0 deletions tests/data/format/multi_style/numpydoc_parameter_spacing.args
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--style=numpydoc
--style=pep257
63 changes: 63 additions & 0 deletions tests/data/format/multi_style/numpydoc_parameter_spacing.py
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 tests/data/format/multi_style/numpydoc_parameter_spacing.py.out
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.
Copy link
Owner

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.

Copy link
Contributor Author

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.

Copy link
Owner

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.


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