docs: Notion accuracy sweep (no version bump)#62
Merged
Conversation
Cross-checked the Notion docs against the code for v1.18.0 through v1.21.0 and fixed three accuracy issues. Docs only, no version bump. - SNAPSHOT_DIFF.md: the --watch summary claimed --format is rejected with --watch. The code allows --format json and --format notion and rejects only other format values. This went stale when watch plus Notion support landed in v1.20.0. Corrected to state the real rule. - LOGGING_STYLE.md: added notion_repair_error (ERROR) and notion_repair_failed (WARNING). Both are emitted by notion_repair.py but were undocumented. Added them to the repair events section and to the v1.20.0 row of the introduced table (confirmed via git that both shipped in v1.20.0). - LOGGING_STYLE.md: fixed the create-database event source path from cli/commands/notion_create_database.py to cli/commands/notion_create.py. Claude-Session: https://claude.ai/code/session_018dxwAxuNy43dbN4pEvKsne
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.
Documentation accuracy sweep for the Notion integration. No version bump, no code changes.
I cross-checked every Notion doc against the code for v1.18.0 through v1.21.0. The flags, env vars, and lifted constraints (watch plus Notion, parallel batch plus Notion, one-command database creation) were already correct across README, CLI_REFERENCE, OUTPUT_FORMATS, CONFIGURATION, NOTION_SETUP, and AGENTS. I found and fixed three accuracy issues.
Fixes
SNAPSHOT_DIFF.md stated a stale constraint. The
--watchsummary said--formatis rejected with--watch. The code (watch.py:153) allows--format jsonand--format notionand rejects only other format values. This went stale when watch plus Notion support landed in v1.20.0. The bullet now states the real rule.LOGGING_STYLE.md was missing two emitted events. The code emits
notion_repair_error(ERROR) andnotion_repair_failed(WARNING) atnotion_repair.py:43,47, but neither was documented. The create section already documents itsnotion_create_failedcounterpart, so this was a gap. Both are now in the repair events section and in the v1.20.0 row of the introduced table. I confirmed withgit log -Sthat both shipped in v1.20.0 (commit 4d47e13).LOGGING_STYLE.md had a wrong file path. The create-database section pointed to
cli/commands/notion_create_database.py. The handler iscli/commands/notion_create.py. Fixed.Verification
The 101 tests under
tests/core/test_logging_vocabulary.pyandtests/docs/pass. No test parses these markdown files for content. The vocabulary meta-test does not scan the Notion modules, so the added events did not need registering there.