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

small bug in 'class Appender' #3106

Closed
cgringmuth opened this issue Jun 2, 2014 · 4 comments
Closed

small bug in 'class Appender' #3106

cgringmuth opened this issue Jun 2, 2014 · 4 comments

Comments

@cgringmuth
Copy link
Contributor

I think there is small bug in the Appender class in docstring.py module?

# version with error
def __call__(self, func):
    docitems = [func.__doc__, self.addendum]
    func.__doc__ = func.__doc__ and ''.join(docitems) # <- here is there error
    return func

# corrected version
def __call__(self, func):
    docitems = [func.__doc__, self.addendum]
    func.__doc__ = func.__doc__ and self.join.join(docitems) # corrected version
    return func

I have tested the corrected version and my correction works as expected.

@tacaswell
Copy link
Member

Can you please put that in a PR?

@cgringmuth
Copy link
Contributor Author

sorry, i'm not sure what do you mean by PR?

EDIT -- sorry, the comment was too fast. You asked me to make a Pull Request ;)

@tacaswell
Copy link
Member

sorry, I fall into jargon far too easily.

@cgringmuth
Copy link
Contributor Author

no problem... i figured that out and already made an pull request. the mistake was very small, so only one line has to be changed in order to work properly again. now the docstrings which are generated with the Appender class are working as normal ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants