Skip to content

Add module docstring to colors module #1476

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.

Sign up for GitHub

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

Open
Mohamed-Elwasila wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add module docstring to colors module #1476

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33d5176
📝 Add module docstring to colors module
Mohamed-Elwasila Jan 6, 2026
f5adc17
Merge branch 'master' into add-colors-module-docstring
svlandeg Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion typer/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Variable names to colors, just for completion
"""Color constants for terminal output styling.

This module provides string constants for standard and bright terminal colors
that can be used with typer's styling functions like `typer.style()` and
`typer.secho()` for the `fg` (foreground) and `bg` (background) parameters.

Example:
>>> import typer
>>> typer.secho("Hello", fg=typer.colors.GREEN)
>>> styled = typer.style("Error", fg=typer.colors.RED, bold=True)
"""

BLACK = "black"
RED = "red"
GREEN = "green"
Expand Down