Skip to content

docs: tidy examples and completed backlog items#36

Open
TristanKruse wants to merge 1 commit into
mainfrom
codex/docs-hygiene
Open

docs: tidy examples and completed backlog items#36
TristanKruse wants to merge 1 commit into
mainfrom
codex/docs-hygiene

Conversation

@TristanKruse

Copy link
Copy Markdown
Collaborator

Pull Request

Correct small documentation inconsistencies without changing runtime behavior:

  • use the .mmd extension for the raw Mermaid export example
  • mark already-delivered backlog items as complete
  • replace stale shouldNot references in comments and docstrings with the current Python API terminology

Change Type

  • Bug fix
  • Feature
  • Documentation
  • Refactoring

Validation:

  • pytest --tb=short -q: 279 passed
  • ruff check src tests scripts: passed
  • mypy src/archunitpython/ --ignore-missing-imports: passed
  • git diff --check: passed

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