-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
DOC: fix typos #20042
Conversation
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
I don't think we should spell-check past release notes. |
I agree past release notes should stay as they are. |
Personally, I don't have a problem with that. |
I don't have a problem with fixing typos in changelogs either. |
You never alter a log post-facto... That's why the officer on watch writes it in ink! |
I don't have a strong opinion on this. |
(I don't either really, unless its a real log, in which case yes, please write in ink ;-) |
Our API changelog/What's new is not particularly immutable; it changes when we update styles and deprecate/remove things. |
I'm mostly 👍 on this. @jklymak the in-ink version in the git history ;) |
The general opinion tends towards including fixes to release notes. Thanks @luzpaz ! |
No description provided.