Refresh README for MoodleClient, doctor, ensure, dry-run, and machine-readable output#58
Merged
Merged
Conversation
…chine-readable output The Features list and library quick-start example predated the recent MoodleClient facade, typed models, doctor diagnostics, idempotent ensure operations, --dry-run previews, and CSV/quiet/no-color/verbose/debug CLI additions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the top-level
README.md(also the docs homepage, viadocs/index.md's--8<-- "README.md"snippet) to reflect everything merged in this session: theMoodleClientfacade, opt-in typed models, thedoctordiagnostics command, idempotentcourses ensure,--dry-runpreviews, and the CSV/--quiet/--no-color/--verbose/--debugCLI additions. The Features list and the Library Usage quick-start example both predated these.Changes
Test plan
pytest tests/unit(no code changes, doc-only) — full suite still passes.mkdocs build --strict— builds cleanly, no new warnings.Backward compatibility
Documentation-only change, no code/behavior impact.
Risk assessment
None — README/docs content only.