Move plotting and geometry utilities to dedicated classes #264
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces #197 in order to address major changes to the wrapper internals.
This addresses #43. I got the ball rolling but it probably won't be finished until I have a complete week or so to dedicate to this. It moves plotting-function enhancements from dedicated "wrapper" functions to the methods themselves and combines the parameter tables associated with each plotting feature into single docstrings.
When using proplot locally, the proplot and matplotlib docstrings will be concatenated with nice headers for each section. 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 localproplotrc
. Then_concatenate_docstrings
skips concatenation ifrcParams['docstring.hardcopy']
isTrue
.