Skip to content

Update README and examples to reflect current API#140

Open
maxime-bc wants to merge 13 commits into
borntyping:mainfrom
maxime-bc:update-readme
Open

Update README and examples to reflect current API#140
maxime-bc wants to merge 13 commits into
borntyping:mainfrom
maxime-bc:update-readme

Conversation

@maxime-bc

@maxime-bc maxime-bc commented Jun 22, 2026

Copy link
Copy Markdown

Hello, this PR aims to refresh the README and examples to better reflect the current colorlog API and behavior.

  • Clarify the colorama note: mark as a dependency on Windows only, not a required dependency, matching the escape_codes.py docstring.
  • Rewrite the ColoredFormatter arguments documentation:
    • group inherited logging.Formatter arguments,
    • document all colorlog-specific arguments with their default values,
    • rename format to fmt and clarify its default behavior,
    • remove obsolete "Available on Python 3.2" note for style.
  • Fix mismatched ColoredFormatter example between README.md, docs/example.py and docs/example.png.
  • Add documentation for 256-color support (fg_0-fg_255, bg_0-bg_255).
  • Update Debian package link from buster to trixie.
  • General cleanup with mdformat.

@maxime-bc maxime-bc marked this pull request as draft June 23, 2026 09:57
@maxime-bc maxime-bc marked this pull request as ready for review June 23, 2026 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant