Skip to content

docs: standardize project terminology - #44

Merged
michalmaj merged 1 commit into
mainfrom
docs/standardize-terminology
Sep 26, 2026
Merged

michalmaj merged 1 commit into
mainfrom
docs/standardize-terminology

Conversation

@michalmaj

Copy link
Copy Markdown
Owner

Summary

Standardize terminology, development dependency commands, and configuration examples across the documentation.

Why

The guide used several names for the same learning path, showed two equivalent forms for adding development dependencies, and contained dependency constraints that no longer matched the repository configuration.

Changes

  • document the preferred spelling of tool names and the terms main learning path and reference material
  • consistently use uv add --group dev in teaching examples
  • align pytest and Ruff constraints with pyproject.toml
  • fix one compound adjective and mark the terminology review complete in the roadmap

Type of change

Select the most relevant option.

  • Documentation
  • Project configuration
  • New feature
  • Tests
  • CI/CD
  • Refactoring
  • Bug fix

Checklist

  • The change is small and focused
  • The pull request title is clear
  • I updated documentation if needed
  • I added or updated tests if needed
  • I ran local checks if applicable

Notes

The official uv documentation confirms that --dev is an alias for
--group dev. This guide consistently uses the explicit group form so beginners
can connect the command with [dependency-groups] in pyproject.toml.

Local checks passed:

  • uv run ruff check .
  • uv run ruff format --check .
  • uv run pytest
  • uv build --no-sources
  • git diff --check

@michalmaj
michalmaj merged commit 781aafa into main Sep 26, 2026
1 check passed
@michalmaj
michalmaj deleted the docs/standardize-terminology branch September 26, 2026 10:34
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