fix(docs): validate documentation against implementation #13
Conversation
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
Fixes discovered during comprehensive documentation validation by 8 subagents: Bug fixes: - Fix CompletionDate mapping to use CompleteTime instead of CloseTime in meetings.py (sync/async consistency issue) - Update tests to match correct field mapping Documentation fixes: - Fix Configuration.configure_api_key() example to use instance method pattern instead of incorrect class method pattern - Add AuthenticationError documentation with proper usage example - Update dependencies list (add pydantic, typing-extensions) - Fix code examples to use correct model field names (complete_date) - Add bulk operations documentation for todos, issues, goals, meetings - Clarify default user ID behavior in user operations - Update method signatures and return types in API reference - Fix async concurrency control documentation (max_concurrent parameter) - Improve error handling examples throughout guides 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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
CompletionDatemapping bug inmeetings.pythat incorrectly usedCloseTimeinstead ofCompleteTimeConfiguration.configure_api_key()documentation example to use instance method patternBug Fixes
Code Fixes
src/bloomy/operations/meetings.py: FixedCompletionDatefield mapping to useCompleteTimeinstead ofCloseTime(sync/async consistency issue)tests/test_todos.py: Updated test to match correct field mappingDocumentation Fixes
docs/api/exceptions.md: AddedAuthenticationErrordocumentation with proper usage exampledocs/getting-started/configuration.md: Fixedconfigure_api_key()example to use instance method patterndocs/getting-started/installation.md: Updated dependencies list (added pydantic, typing-extensions)docs/guide/authentication.md: Improved debugging examplesdocs/guide/errors.md: Added comprehensive error handling examplesdocs/api/operations/*.md: Updated all operations documentation with:complete_dateinstead ofcomplete_time)create_many,get_many)max_concurrentparameter)Test Plan
mkdocs build --strict)🤖 Generated with Claude Code