Skip to content

Fix AttributeError in scripts/validate_docstrings for doc.returns[0].name #27623

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

Conversation

albertvillanova
Copy link
Contributor

@jreback
Copy link
Contributor

jreback commented Jul 27, 2019

can you add some tests for this

@jreback jreback added the Docs label Jul 27, 2019
@WillAyd
Copy link
Member

WillAyd commented Jul 27, 2019

What version of numpydoc is this? IIRC they have been using named tuples in more recent versions which is preferable from a readability perspective. Does upgrading resolve your issue?

@albertvillanova
Copy link
Contributor Author

@WillAyd, yes you are right: since numpydoc version 0.9, they use a Parameter named tuple (numpy/numpydoc@136d4dd); I have v0.8.0 in my pandas dev environment.

@WillAyd
Copy link
Member

WillAyd commented Jul 27, 2019 via email

@gfyoung
Copy link
Member

gfyoung commented Jul 28, 2019

Still pretty new (0.9 came out in April) but I think OK for a dev dependency.

I'm in agreement on this. We can be a little more aggressive for development dependencies.

@WillAyd
Copy link
Member

WillAyd commented Aug 2, 2019

We actually already do require this in environment.yaml per #26188 so I don't think anything to do here (unless we care to document further)

@gfyoung
Copy link
Member

gfyoung commented Aug 2, 2019

I don't think anything to do here

I'm agreement with this.

@albertvillanova : I'm closing this because the fix is just to upgrade to numpydoc per the new requirements on master. Thanks for contributing though! You are more than welcome to tackle any of our other open issues in our issue tracker.

@gfyoung gfyoung closed this Aug 2, 2019
@gfyoung gfyoung added this to the No action milestone Aug 2, 2019
@albertvillanova
Copy link
Contributor Author

Yes, I had noticed the version requirement in environment.yaml.

@gfyoung @WillAyd What about documenting how to update the dev environment in Contributing section?

@gfyoung
Copy link
Member

gfyoung commented Aug 3, 2019

When you say document, what would you add about upgrading? It’s just doing a pip or conda upgrade, no?

@albertvillanova
Copy link
Contributor Author

You have thoroughly documented the creation of the dev environment using the environment.yaml file. However nothing is said about updating it (using the environment.yaml, which might have changed since the last time, with new packages or new version requirements). Nevertheless, if you think it is OK as it is... Nevermind!

@gfyoung
Copy link
Member

gfyoung commented Aug 3, 2019

Nevertheless, if you think it is OK as it is... Nevermind!

Not saying that I think it's OK as is. I'm just trying to understand what you wanted to do.

Why don't you submit a PR, and we can better evaluate.

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

Successfully merging this pull request may close these issues.

BUG: AttributeError in scripts/validate_docstrings for doc.returns[0].name
4 participants