gh-138772: Improve documentation for turtle color functions #139325
+41
−11
Conversation
This file contains hidden or 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
serhiy-storchaka
added
docs
Use multiple signatures for clarity. Explain different forms of bgcolor() in details.
serhiy-storchaka
force-pushed
the
turtle-color-docs
branch
from
26df454 to
78c3b27
Compare
encukou
reviewed
Oct 7, 2025
Comment on lines
+1890
to
+1909
| Four input formats are allowed: | ||
|
|
||
| ``bgcolor()`` | ||
| Return the current background color as color specification string or | ||
| as a tuple (see example). May be used as input to another | ||
| color/pencolor/fillcolor/bgcolor call. | ||
|
|
||
| ``bgcolor(colorstring)`` | ||
| Set the background color to *colorstring*, which is a Tk color | ||
| specification string, such as ``"red"``, ``"yellow"``, or ``"#33cc8c"``. | ||
|
|
||
| Set or return background color of the TurtleScreen. | ||
| ``bgcolor((r, g, b))`` | ||
| Set the background color to the RGB color represented by the tuple of | ||
| *r*, *g*, and *b*. | ||
| Each of *r*, *g*, and *b* must be in the range 0..colormode, where | ||
| colormode is either 1.0 or 255 (see :func:`colormode`). | ||
|
|
||
| ``bgcolor(r, g, b)`` | ||
| Set the background color to the RGB color represented by *r*, *g*, and *b*. Each of | ||
| *r*, *g*, and *b* must be in the range 0..colormode. |
There was a problem hiding this comment.
Do you think it could it be better to link to a more commonly used function, rather than repeat all the info?
Suggested change
| Four input formats are allowed: | |
| ``bgcolor()`` | |
| Return the current background color as color specification string or | |
| as a tuple (see example). May be used as input to another | |
| color/pencolor/fillcolor/bgcolor call. | |
| ``bgcolor(colorstring)`` | |
| Set the background color to *colorstring*, which is a Tk color | |
| specification string, such as ``"red"``, ``"yellow"``, or ``"#33cc8c"``. | |
| Set or return background color of the TurtleScreen. | |
| ``bgcolor((r, g, b))`` | |
| Set the background color to the RGB color represented by the tuple of | |
| *r*, *g*, and *b*. | |
| Each of *r*, *g*, and *b* must be in the range 0..colormode, where | |
| colormode is either 1.0 or 255 (see :func:`colormode`). | |
| ``bgcolor(r, g, b)`` | |
| Set the background color to the RGB color represented by *r*, *g*, and *b*. Each of | |
| *r*, *g*, and *b* must be in the range 0..colormode. | |
| The arguments use the same format as :func:`fillcolor`. |
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.
Use multiple signatures for clarity.
Explain different forms of bgcolor() in details.
📚 Documentation preview 📚: https://cpython-previews--139325.org.readthedocs.build/