Adds docstrings to demo_curvelinear_grid.py and demo_curvelinear_grid…#7250
Adds docstrings to demo_curvelinear_grid.py and demo_curvelinear_grid…#7250NelleV merged 3 commits intomatplotlib:masterfrom
Conversation
|
It looks like some extraneous files got committed. Can you remove those from the git history and then force push? # make sure you are on your working branch
$ git checkout 7206-MEP12-compliant-Plots
# do this a bunch of times
$ git rm file_name
# ammend the last commit
$ git commit --amend
# _FORCE_ push to github.
# this is dangerous, use with caution
$ git push trpham 7206-MEP12-compliant-Plots --force |
tacaswell
left a comment
tacaswell
left a comment
There was a problem hiding this comment.
Need to remove extra files.
|
Hi @trpham """ description |
| @@ -1,3 +1,17 @@ | |||
| """ | |||
| Demo of defining curvilinear coordinate using GridHelperCurveLinear and Transformation. | |||
There was a problem hiding this comment.
The docstring looks good overall, but here is a couple of improvements you should make:
- Let's try to make the title shorter: something like "Curvilinear coordinates" would be better.
- Add a sentence at the beginning of the paragraph to introduce it: This examples illustrates how to define curvilinar coordinates using GridHelperCurveLinear and Transformation".
QuLogic
left a comment
QuLogic
left a comment
There was a problem hiding this comment.
I'm not really sure about this docstring; it mostly seems to echo what's in the comments in the code itself. The docstring should be more of a "why do this?" rather than "what are we doing?".
| @@ -1,3 +1,17 @@ | |||
| """ | |||
| Demo of defining curvilinear coordinate using GridHelperCurveLinear and Transformation. | |||
| """ | ||
| Demo of defining curvilinear coordinate using GridHelperCurveLinear and Transformation. | ||
| In curvelinear_test1: Use GridHelper class | ||
| * User provides two transformtions function between curved coordinate and rectlinear coordinate |
| In curvelinear_test1: Use GridHelper class | ||
| * User provides two transformtions function between curved coordinate and rectlinear coordinate | ||
| * Calling GridHelperCurveLinear on those two functions. | ||
| * Setting a subplot positioned by the given gird definition |
| * Calling GridHelperCurveLinear on those two functions. | ||
| * Setting a subplot positioned by the given gird definition | ||
| In curvelinear_test2: Use Affine2D transform | ||
| * Calling PolerTransform |
| * Setting a subplot positioned by the given gird definition | ||
| In curvelinear_test2: Use Affine2D transform | ||
| * Calling PolerTransform | ||
| * Setting the range of coordinate using Extream Finder |
| * Setting the range of coordinate using Extream Finder | ||
| * Locate the coordinate with LocatorDMS and format them with FormatterDMS | ||
| * Calling GridHelperCurveLinear | ||
| * Setting a subplot positioned by the given gird definition |
trpham
force-pushed
the
7206-MEP12-compliant-Plots
branch
from
10e9bea to
aacb002
Compare
… demo_curvelinear_grid2.py
|
Hi @trpham """ This example demonstrates how to use GridHelperCurveLinear to define custom grids and ticklines by applying a transformation on the grid. This can be used, as showcase on the second plot, to create polar projections in a rectangular box. You can leave the second example as is. I think it needs to be removed or updated to be interesting. |
…grid2.py to match recommended format
NelleV
changed the title
|
The first commit has a confusing commit message; no files were removed at the time. |
|
@tacaswell Why has this been tagged for 2.0? This is not a bug fix. |
QuLogic
changed the title
…lots Adds docstrings to demo_curvelinear_grid.py and demo_curvelinear_grid…
|
Backported to v2.x via bceea0c. |
QuLogic
modified the milestones:
2.0.1 (next bug fix release),
2.0 (style change major release)
5 participants
No description provided.