Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Implement plotting overrides in plotting methods themselves, instead of "wrappers" #111

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

Closed
wants to merge 5 commits into from

Conversation

lukelbd
Copy link
Collaborator

@lukelbd lukelbd commented Jan 20, 2020

This PR replaces #45 in order to clean up its history.

This addresses #43. It moves plotting-function enhancements from dedicated "wrapper" functions to the methods themselves, breaks apart some really unwieldy wrappers into their component parts, and (just like matplotlib) combines the keyword arg tables associated with each plotting wrapper using matplotlib.docstring.dedent_interpd.

  • This will make it much easier for new users to learn ProPlot -- people have a hard time wrapping their heads around wrapper functions ;)
  • This will also make the tracebacks much cleaner. It can be pretty disorienting when an error is raised and there are 3x more frames than necessary.

When using proplot locally, the proplot and matplotlibdocstrings will be concatenated with nice headers for each section using _concatenate_docstrings in axes.py. When sphinx is importing proplot for generating documentation, they will not be concatenated -- only the proplot docstring will be shown with an intersphinx link to the matplotlib one. This is done by adding docstring.hardcopy: True to the local .proplotrc. Then _concatenate_docstrings skips concatenation if rcParams['docstring.hardcopy'] is True.

@lukelbd lukelbd changed the title Add plotting methods Implement plotting overrides on plotting methods themselves, instead of "wrappers" Jan 20, 2020
@lukelbd lukelbd changed the title Implement plotting overrides on plotting methods themselves, instead of "wrappers" Implement plotting overrides in plotting methods themselves, instead of "wrappers" Feb 11, 2020
@lukelbd
Copy link
Collaborator Author

lukelbd commented Jun 21, 2020

Closed by #197

@lukelbd lukelbd closed this Jun 21, 2020
@lukelbd lukelbd deleted the add-plotting-methods branch June 21, 2020 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant