[Doc] Improve description of the pos parameter in gui #1904
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current description of parameter pos in gui.text doesn't explicitly show it's intended value range. Same issue exists for other objects. I can make a through chk and update if you think the change is valuable. Thank you!
houkensjtu
changed the title
archibate
reviewed
Sep 29, 2020
There was a problem hiding this comment.
Good idea! LGTM but I've several concerns:
- There're more than one place we have
posin GUI doc, will we modify them too? - Thank for clarifying
[0, 1], shall we also claim that X is from left to right and Y is from down to up?
So I'd suggest - instead of repeating ourselves by adding range [0,1] to all pos occasions, how about to add a brief introduction on what's the coordinate system Taichi GUI uses at the beginning of this doc, so that users will automatically know what the following pos means?
docs/gui.rst
Outdated
| @@ -202,7 +202,7 @@ Paint on a window | |||
|
|
|||
| :parameter gui: (GUI) the window object | |||
| :parameter content: (str) the text to draw | |||
| :parameter pos: (tuple of 2) the top-left point position of the fonts / texts | |||
| :parameter pos: (tuple of 2, range [0,1] ) the relative position of the top-left point of the fonts / texts | |||
There was a problem hiding this comment.
Suggested change
| :parameter pos: (tuple of 2, range [0,1] ) the relative position of the top-left point of the fonts / texts | |
| :parameter pos: (tuple of 2, range [0,1]) the relative position of the top-left point of the fonts / texts |
There was a problem hiding this comment.
I agree! I submitted a new commit with a brief introduction section. The explanation of pos goes into a Note section. Please review.
Codecov Report
@@ Coverage Diff @@
## master #1904 +/- ##
==========================================
+ Coverage 43.19% 44.14% +0.95%
==========================================
Files 44 44
Lines 6330 6121 -209
Branches 1092 1092
==========================================
- Hits 2734 2702 -32
+ Misses 3426 3250 -176
+ Partials 170 169 -1
Continue to review full report at Codecov.
|
yuanming-hu
approved these changes
Oct 3, 2020
Co-authored-by: Yuanming Hu <yuanming-hu@users.noreply.github.com>
Co-authored-by: Yuanming Hu <yuanming-hu@users.noreply.github.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current description of parameter pos in gui.text doesn't explicitly show it's intended value range.
Same issue exists for other objects. I can make a through chk and update if you think the change is valuable.
Thank you!
Related issue = #
[Click here for the format server]