Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: separate and clarify axisartist default tables#26754
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
b74aea1 to7884883Compare7884883 toe920a6dCompareThere 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.
+1 on splitting the table. -1 on changing to list table style. As said in#26737 (comment)
As long as the tables are small (like in this example), I prefer ReST simple tables. Yes they are more cumbersome to update but they are much easier to read, and readability counts. It's not that we are changing these tables all the time.
I may be the anomaly but I don't find the list tables harder to read if the table is sensible since it's still row/column order. And I usually have the rendered docs open. On the flip side, I find the hardcoded tables orders of magnitude more annoying to edit - I dunno if it's a byproduct of being on Windows or eyestrain but I always manage to miss something, especially when I have to cascade the changes. |
I accept your different standpoint. Let’s if others have an opinion. |
I'm with Tim here. Two tables clearly made it better (from both source and rendering perspectives), but still I find the "hard-to-edit" tables much easier to understand. |
e920a6d to9378efeComparechanged to grid tables c/o nice vs code plugins + table usage doc/section formatting |
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 good to go modulo the typos.
doc/devel/document.rst Outdated
| +-------------+-------------------------------+--------------------+ | ||
| | | small table | large table | | ||
| +-------------+-------------------------------+--------------------+ | ||
| | short entry | `simple or grid table <sg>`__ | `grid table <sg>`_ | |
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.
I think there's one underscore too much:
| |short entry | `simple or grid table <sg>`__ | `grid table <sg>`_ | | |
| |short entry | `simple or grid table <sg>`_ | `grid table <sg>`_ | |
| ==================== | ||
| Theaxisartist toolkit | ||
| ==================== |
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.
I assume this is unintended. Have you been playing with table formatting too much? 😜
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.
probably a format all instead of format this
fixed |
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.
Any body can merge after applying above heading formatting suggestion.
Uh oh!
There was an error while loading.Please reload this page.
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free tosuggest an improvement. |
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free tosuggest an improvement. |
Uh oh!
There was an error while loading.Please reload this page.
PR summary
Based on discussion in#26737, rotated the parameter default table in theAxisArtist guide and seperated it out into two to try and clarify that the table is showing the default label parameter values for each reference direction.
general new look:
attn:@oscargus
PR checklist