Skip to content

PR: Improve Docstrings Redux#1357

Merged
KelSolaar merged 26 commits intodevelopfrom
feature/docstrings
Aug 24, 2025
Merged

PR: Improve Docstrings Redux#1357
KelSolaar merged 26 commits intodevelopfrom
feature/docstrings

Conversation

@KelSolaar
Copy link
Copy Markdown
Member

Summary

This PR performs a second pass of docstrings improvements using https://github.com/colour-science/colour-science.meta/blob/master/.claude/scripts/docstring_processor.py and a gazillion of extra polishing passes.

Preflight

Code Style and Quality

  • Unit tests have been implemented and passed.
  • Pyright static checking has been run and passed.
  • Pre-commit hooks have been run and passed.
  • New transformations have been added to the Automatic Colour Conversion Graph.
  • New transformations have been exported to the relevant namespaces, e.g. colour, colour.models.

Documentation

  • New features are documented along with examples if relevant.
  • The documentation is Sphinx and numpydoc compliant.

@KelSolaar KelSolaar merged commit bd8aa6f into develop Aug 24, 2025
29 checks passed
@KelSolaar KelSolaar deleted the feature/docstrings branch August 24, 2025 08:05
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