Skip to content

Imperative mood for docstring summaries #92

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
lukelbd merged 16 commits into from
Jan 7, 2020
Merged

Imperative mood for docstring summaries #92

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
df6e404
Initial commit
lukelbd Dec 19, 2019
b6c23c4
Merge branch 'master' into imperative-mood
lukelbd Jan 7, 2020
a6858ad
Merge branch 'master' into imperative-mood
lukelbd Jan 7, 2020
7498695
Imperative mood for axes and axistools docstrings
lukelbd Jan 7, 2020
f0b13eb
Remove print statement
lukelbd Jan 7, 2020
0fe7f50
Utils docs cleanup
lukelbd Jan 7, 2020
6976ffa
utils.py docs cleanup
lukelbd Jan 7, 2020
9c74cb0
wrappers.py docs cleanup
lukelbd Jan 7, 2020
002b7b5
styletools.py docs cleanup
lukelbd Jan 7, 2020
94b6022
projs.py docs cleanup, Proj returns just the class
lukelbd Jan 7, 2020
03a3e37
subplots.py docs cleanup
lukelbd Jan 7, 2020
44fb032
Cleanup Figure methods and subplots.py docs
lukelbd Jan 7, 2020
5493f61
subplots() bugfix, calculate aspect from Proj return val
lukelbd Jan 7, 2020
0de202f
Proj() bugfix
lukelbd Jan 7, 2020
95029cf
edges() bugfix
lukelbd Jan 7, 2020
caf8855
Notebook example cleanup
lukelbd Jan 7, 2020
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
Prev Previous commit
Next Next commit
utils.py docs cleanup
  • Loading branch information
@lukelbd
lukelbd committed Jan 7, 2020
commit 6976ffa70668e55d86b6bc7e305e4bd2789a71e6
4 changes: 2 additions & 2 deletions proplot/wrappers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2999,8 +2999,8 @@ def _wrapper(self, *args, **kwargs):


def _wrapper_decorator(driver):
"""Generates generic wrapper decorators and dynamically modifies docstring
to list the methods wrapped by this function. Also sets __doc__ to None so
"""Generate generic wrapper decorator and dynamically modify the docstring
to list methods wrapped by this function. Also set `__doc__` to ``None`` so
that ProPlot fork of automodapi doesn't add these methods to the website
documentation. Users can still call help(ax.method) because python looks
for superclass method docstrings if a docstring is empty."""
Expand Down