Skip to content

DOC: fix typos #20042

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

Merged
merged 2 commits into from
Apr 23, 2021
Merged

DOC: fix typos #20042

merged 2 commits into from
Apr 23, 2021

Conversation

luzpaz
Copy link
Contributor

@luzpaz luzpaz commented Apr 22, 2021

No description provided.

@luzpaz
Copy link
Contributor Author

luzpaz commented Apr 22, 2021

b183eae contains changes to some older documentation hence separated in to another commit for easier review.

@@ -1785,7 +1785,7 @@ def _draw_frame(self, framedata):
except TypeError:
raise err from None

# check each item if is artist
# check each item if it's artist
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better just delete this comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure, I can also mimic the neighboring comments with # check if each item is artist

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's basically what the code does; there's no point in having the comment.

@@ -1739,7 +1739,7 @@ def __call__(self, value, clip=None):
else:
max_col = self.Ncmap
# this gives us the bins in the lookup table in the range
# [0, _n_regions - 1] (the offset is baked in in the init)
# [0, _n_regions - 1] (the offset is baked in the init)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a typo.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prob should be baked-in in the init

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixing this in a follow-up PR since this one was merged before I could address it.

@jklymak
Copy link
Member

jklymak commented Apr 22, 2021

I don't think we should spell-check past release notes.

@anntzer
Copy link
Contributor

anntzer commented Apr 22, 2021

I agree past release notes should stay as they are.

@QuLogic
Copy link
Member

QuLogic commented Apr 22, 2021

Personally, I don't have a problem with that.

@timhoffm
Copy link
Member

I don't have a problem with fixing typos in changelogs either.

@jklymak
Copy link
Member

jklymak commented Apr 22, 2021

You never alter a log post-facto... That's why the officer on watch writes it in ink!

@timhoffm
Copy link
Member

I don't have a strong opinion on this.

@jklymak
Copy link
Member

jklymak commented Apr 23, 2021

(I don't either really, unless its a real log, in which case yes, please write in ink ;-)

@QuLogic
Copy link
Member

QuLogic commented Apr 23, 2021

Our API changelog/What's new is not particularly immutable; it changes when we update styles and deprecate/remove things.

@tacaswell
Copy link
Member

I'm mostly 👍 on this.

@jklymak the in-ink version in the git history ;)

@tacaswell tacaswell added this to the v3.5.0 milestone Apr 23, 2021
@timhoffm timhoffm merged commit bc5d5b8 into matplotlib:master Apr 23, 2021
@timhoffm
Copy link
Member

timhoffm commented Apr 23, 2021

The general opinion tends towards including fixes to release notes.

Thanks @luzpaz !

@luzpaz luzpaz deleted the typos-cont branch April 24, 2021 13:14
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.

6 participants