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: numpy returns handles more name, type cases #174

Merged
merged 6 commits into from
Jul 13, 2023

Conversation

machow
Copy link
Contributor

@machow machow commented Jun 26, 2023

Addresses #173 . I'm not particularly good and regexes, so definitely feel free to take this as more of a demonstration of the issue. Happy to make any tweaks / changes :)

Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @machow for all your contributions, you're awesome 😄
A few comments 🙂

src/griffe/docstrings/numpy.py Outdated Show resolved Hide resolved
tests/test_docstrings/test_numpy.py Outdated Show resolved Hide resolved
@machow machow requested a review from pawamoy June 28, 2023 16:31
@machow
Copy link
Contributor Author

machow commented Jun 28, 2023

@pawamoy, alright, I think assert_element_equal should be checking all the attributes now. Happy to make any other useful changes

@pawamoy
Copy link
Member

pawamoy commented Jun 29, 2023

I'm waiting for an answer at numpy/numpydoc#463. Numpydoc maintainers don't particularly like the : and : int syntax. If we can't find a better alternative, we'll go ahead with it 🙂

@pawamoy
Copy link
Member

pawamoy commented Jul 4, 2023

Lets wait a few more days, and then proceed to merge. I don't think the discussion on numpydoc will yield immediate results anyway. I'm OK with driving changes rather than waiting for them 🙂

Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, LGTM now, what do you think? I'm ready to squash and merge 🙂

@pawamoy
Copy link
Member

pawamoy commented Jul 13, 2023

Merging, thanks again @machow !

@pawamoy pawamoy merged commit bdec37d into mkdocstrings:main Jul 13, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 25, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 25, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 25, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 25, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 25, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 25, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 26, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 26, 2023
jgarte added a commit to jgarte/griffe that referenced this pull request Jul 26, 2023
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

Successfully merging this pull request may close these issues.

2 participants