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

Skip to content

[Doc]: Transformation tutorial uses outdated description for polar transform #24499

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

Jump to bottom
Open
anntzer opened this issue Nov 18, 2022 · 3 comments
Open

[Doc]: Transformation tutorial uses outdated description for polar transform #24499

anntzer opened this issue Nov 18, 2022 · 3 comments
Labels
Documentation topic: polar topic: transforms and scales

Comments

@anntzer
Copy link
Contributor

anntzer commented Nov 18, 2022

Documentation Link

https://matplotlib.org/stable/tutorials/advanced/transforms_tutorial.html#the-transformation-pipeline

Problem

The docs currently state

For non-separable axes the PolarAxes, there is one more piece to consider, the projection transformation. The transData matplotlib.projections.polar.PolarAxes is similar to that for the typical separable matplotlib Axes, with one additional piece transProjection:

self.transData = self.transScale + self.transProjection + \
    (self.transProjectionAffine + self.transAxes)

but this is currently outdated: the polar transData is now

        self.transData = (
            self.transScale + self.transShift + self.transProjection +
            (self.transProjectionAffine + self.transWedge + self.transAxes))

(since some old changes by @QuLogic)

Suggested improvement

I'm not actually sure we need to go into these details in the transformation tutorial so perhaps the entire section can be rewritten to remove the details, but if we do keep that information it should be updated.
saranti added a commit to saranti/matplotlib that referenced this issue Dec 2, 2022
@saranti
Update the description for the polar transData doc matplotlib#24499
3a5f2c1
saranti added a commit to saranti/matplotlib that referenced this issue Dec 2, 2022
@saranti
Update the polar transform information in doc matplotlib#24499
85e424f
@saranti
Copy link
Contributor

saranti commented Dec 2, 2022

I just updated the information instead of removing the section because it was the minimal change to make.

QuLogic added a commit that referenced this issue Dec 3, 2022
@QuLogic
Merge pull request #24580 from saranti/update-doc
7f7dfc9 
Update the polar transform information in doc #24499
@meeseeksmachine meeseeksmachine mentioned this issue Dec 3, 2022
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this issue Dec 3, 2022
@QuLogic @meeseeksmachine
Backport PR matplotlib#24580: Update the polar transform information …
c7807ae 
…in doc matplotlib#24499
@meeseeksmachine meeseeksmachine mentioned this issue Dec 3, 2022
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this issue Dec 3, 2022
@QuLogic @meeseeksmachine
Backport PR matplotlib#24580: Update the polar transform information …
079e8b7 
…in doc matplotlib#24499
@QuLogic
Copy link
Member

QuLogic commented Dec 3, 2022

I'm not actually sure we need to go into these details in the transformation tutorial so perhaps the entire section can be rewritten to remove the details, but if we do keep that information it should be updated.

@anntzer Up to you if you want to keep this open for a more substantial rewrite.

QuLogic added a commit that referenced this issue Dec 3, 2022
@QuLogic
Merge pull request #24594 from meeseeksmachine/auto-backport-of-pr-24…
05379ab 
…580-on-v3.6.2-doc

Backport PR #24580 on branch v3.6.2-doc (Update the polar transform information in doc #24499)
QuLogic added a commit that referenced this issue Dec 3, 2022
@QuLogic
Merge pull request #24593 from meeseeksmachine/auto-backport-of-pr-24…
b6b731e 
…580-on-v3.6.x

Backport PR #24580 on branch v3.6.x (Update the polar transform information in doc #24499)
@anntzer
Copy link
Contributor Author

anntzer commented Dec 3, 2022

The sentence immediately before ("The transData matplotlib.projections.polar.PolarAxes is similar to that for the typical separable matplotlib Axes, with one additional piece transProjection:") is still wrong: there's three additional pieces -- transProjection, transProjectionAffine, and transWedge... (Also, an "of" seems to be missing right after "transData", and likewise a word seems missing in the sentence immediately before: "For non-separable axes the PolarAxes, ...")

raphaelquast pushed a commit to raphaelquast/matplotlib that referenced this issue Dec 5, 2022
@saranti @raphaelquast
Update the polar transform information in doc matplotlib#24499
fdb45ea
melissawm pushed a commit to melissawm/matplotlib that referenced this issue Dec 19, 2022
@saranti @melissawm
Update the polar transform information in doc matplotlib#24499
37f8ba2
@ksunden ksunden mentioned this issue Feb 20, 2023
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation topic: polar topic: transforms and scales
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@QuLogic @anntzer @dstansby @saranti