-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: Fix colLoc default #26696
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 colLoc default #26696
Conversation
I took the liberty to merge a fix removing a trailing space that I had introduced in the earlier suggestion... |
Thanks @oscargus and @QuLogic for your reviews. I took this opportunity to take another look at the rules for docstrings in matplotlib (this referring to numpydoc] and it says
so I reordered the options accordingling and removed the explict mentioning of the default value in the docstring. I further noticed that matplotlib/lib/matplotlib/table.py Line 60 in 781c6a0
which is then set to matplotlib/lib/matplotlib/table.py Lines 100 to 101 in 781c6a0
so I took the liberty to change the default directly to |
Could you add an api change note if it isn't too much trouble? |
What is the API change? The default value in the signature changed, but the run time behavior should not have changed. |
Isn't that usually something we flag as an API change even if the behavior doesn't change? Just in case someone was relying on it?
|
As I said before, I'm happy with any of the three options:
I tried to find an answer to the question about API changes in the documentation and found this:
which leads to the question who the API consistency lead developer is. |
@timhoffm - that info lives at https://matplotlib.org/governance/people.html#deputy-project-leads |
No API change note is a bit too adventurous. If we wanted to be very defensive, the removal of |
@story645 I added the API change note. The Sphinx |
You'll need to rebase to fix CI. |
- fix colLoc default - make docs in table.py conform to numpydoc - move setting default value of loc of Cell from code to signature
Thanks for going the extra steps of making the API note! |
PR summary
colLoc
defaultloc
of Cell from code to signaturePR checklist