Skip to content

Fixed code issue from compat with new numpydoc #26188

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Apr 23, 2019
Merged

Fixed code issue from compat with new numpydoc #26188

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64cce77
Fixed code issue from compat with new numpydoc
WillAyd Apr 22, 2019
5574b4d
Bumped min environment reqs
WillAyd Apr 22, 2019
ada0154
Updated method
WillAyd Apr 23, 2019
097f6ef
LINT fixup
WillAyd Apr 23, 2019
3a7e4e4
Fixed returns regression
WillAyd Apr 23, 2019
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 environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ dependencies:
- pytest>=4.0.2
- pytest-mock
- sphinx
- numpydoc
- numpydoc>=0.9.0
- pip

# optional
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pycodestyle
pytest>=4.0.2
pytest-mock
sphinx
numpydoc
numpydoc>=0.9.0
pip
beautifulsoup4>=4.2.1
blosc
Expand Down
9 changes: 6 additions & 3 deletions scripts/validate_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,9 +472,12 @@ def parameter_desc(self, param):

@property
def see_also(self):
return collections.OrderedDict((name, ''.join(desc))
for name, desc, _
in self.doc['See Also'])
result = collections.OrderedDict()
for funcs, desc in self.doc['See Also']:
Copy link
Contributor

Choose a reason for hiding this comment

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

could write this as a list comprehension but not a big deal

for func, _ in funcs:
result[func] = ''.join(desc)

return result

@property
def examples(self):
Expand Down