gh-148330: Add docstrings to module colorsys in all functions#148332
gh-148330: Add docstrings to module colorsys in all functions#148332aiwonderland wants to merge 1 commit intopython:mainfrom
Conversation
|
The following commit authors need to sign the Contributor License Agreement: |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
aiwonderland
force-pushed
the
doc-colorsys-add-docstrings
branch
from
4a1a16c to
5209a13
Compare
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
aiwonderland
changed the title
| # The ones in this library uses constants from the FCC version of NTSC. | ||
|
|
||
| def rgb_to_yiq(r, g, b): | ||
| """Convert RGB to YIQ. |
There was a problem hiding this comment.
This is good, but just to clean it up a little more, just put the string next to the start of the doctoring on another line. For example:
Instead of
"""Convert RGB to YIQ.
"""
It becomes
"""
Convert RGB to YIQ.
"""
And this change would apply to the other lines that follow this pattern as well.
3 participants
gh-148330: colorsys: Add docstrings to module and all functions
Add module-level
__doc__and consistent docstrings to all colorsys conversion functions.Fixes help() output for colorsys APIs and follows standard library style.