Skip to content

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

Merged
merged 3 commits into from
May 20, 2023

Conversation

eschan145
Copy link
Contributor

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.

Added a lot of documentation and a good tutorial on the GUI concepts. Also added more reStructuredText formatting.
@einarf einarf requested a review from eruvanos April 4, 2023 23:14
Copy link
Member

@pushfoo pushfoo left a 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.

eschan145 and others added 2 commits April 4, 2023 19:55
Thanks @pushfoo!

Co-authored-by: Paul <36696816+pushfoo@users.noreply.github.com>
* Wrapped lines to eighty characters
@eschan145 eschan145 deleted the branch pythonarcade:development April 5, 2023 17:18
@eschan145 eschan145 closed this Apr 5, 2023
@eschan145 eschan145 deleted the development branch April 5, 2023 17:18
@eschan145 eschan145 restored the development branch April 5, 2023 17:20
@eschan145 eschan145 reopened this Apr 5, 2023
@pvcraven
Copy link
Member

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.

Copy link
Member

@eruvanos eruvanos left a 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.

@eruvanos eruvanos merged commit 0f65427 into pythonarcade:development May 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants