-
Notifications
You must be signed in to change notification settings - Fork 343
Improve layout and formatting of concept.rst
for GUI system docs
#1680
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
Conversation
Added a lot of documentation and a good tutorial on the GUI concepts. Also added more reStructuredText 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.
tl;dr: good job overall. I have concerns about removing a section, made grammar / clarity suggestions in parts crucial to beginners
I made some specific phrasing tweak suggestions to fix grammar & clarity of beginner-relevant sections, but I'll leave out suggestions for the Rendering and UILayout section because I don't think I understand them well enough.
We may want to keep the hierarchical listing of UIWidgets because the titles do not show up in the sidebar. Adding link targets to each heading we could link from the overview would set us up for improving docstrings down the line in the same way einarf has approved of in #1620.
Thanks @pushfoo! Co-authored-by: Paul <36696816+pushfoo@users.noreply.github.com>
* Wrapped lines to eighty characters
How are we feeling about this PR? I know there are some open conversations, but it looks like this is still an improvement as-is. |
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.
Thanks for your work, beside some open points, which were mentioned by @pushfoo it is a grade improvement of the current docs. As mentioned, we can address those points later.
Added a lot of documentation and a good tutorial on the GUI concepts. Also added more reStructuredText formatting.
Pyglet spells its own name with a lowercase first letter, so I have included it here. I also added documentation on styling here, maybe later that might be moved to
style.rst
. It's easier to visualize when you have style and widgets next to each other.Also moved some text (such as parameters, class names) into code blocks to make it look neater. Please let me know if you have any suggestions.