Minor improvements to GUI system #1690
Conversation
Added a lot of documentation and a good tutorial on the GUI concepts. Also added more reStructuredText formatting.
Thanks @pushfoo! Co-authored-by: Paul <36696816+pushfoo@users.noreply.github.com>
* Wrapped lines to eighty characters
I intend to add some more commits later. I have to say, though, this traditional RST parameter formatting looks really ugly and I may need to squish text into very small areas. I additionally added a `caret_color` parameter to `UIInputText` allowing users to specify a color for the caret.
* Fixed extra trailing whitespace * Fixed missing colon * Fixed missing import
Thanks @gran4!
There was a problem hiding this comment.
Good catch on Caret being RGB-only in pyglet's source. That's something which needs to be addressed upstream. I'll give this PR a more thorough look later.
EDIT: I filed a ticket with pyglet checking for any blockers for making Caret take RGBA pyglet/pyglet#805
|
@eschan145 For me it looks good in general, just fix the build error and we can merge it |
|
Something may be wrong with Sphinx here. The error still occurs locally after removing the top-level docstring from |
There was a problem hiding this comment.
- It's actually the
\ninUITextWidget.multilinecausing the error; make it\\n - Our Sphinx version is broken, but I have a fix for that too (see Fix doc build warning misattributions by upgrading Sphinx #1745)
I have further suggestions, but the above should get this building & mergable. Having trouble fixing this isn't OP's fault.
Co-authored-by: Paul <36696816+pushfoo@users.noreply.github.com>
|
Fixed the lingering issue with RGB just to check if things build. I'm guessing it should be |
|
Finally merged, thanks for your work |
The parameter docs look very ugly and compacted with the native RST formatting. Switching to Google-style would also leave me with more space to fit more characters per line.