docs: clarify automatic checks in built-in editor - #138
Open
frobel0520 wants to merge 1 commit into
Open
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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
Closes #78.
Clarify that the automatic edit-check-advance loop is provided by the built-in editor.
Document that external editors require saving the exercise and running pythonlings run manually. Update the how-it-works, quick-start, and homepage documentation to keep the workflow description consistent.
Tests
mkdocs build --strict— passedpython -m pythonlings --root tests/fixtures/passing_curriculum verify— passed (passing1, passing2)python -m pytest -q— 208 passed, 7 failed in this Windows environment:git diff --check— passedThe strict documentation build also reports only existing warnings: the future MkDocs 2.0 compatibility warning and docs-site/AGENTS.md being outside the navigation.
Screenshots
Not applicable; documentation wording only.
Checklist
python -m pytest -q— run; environment-only failures are documented above