Issue documentation improvements #199
Open
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
fix(docs): correct API routes section with proper dependency injection and error handling - Add consistent Annotated[AsyncSession, Depends(async_get_db)] pattern across all examples - Fix missing database dependency injections in endpoint examples - Standardize on explicit boolean checks (is None, is True, is False) for clarity - Include proper imports in all code snippets - Improve pagination examples with complete import statements - Enhance exception handling examples with realistic use cases - Update navigation flow between sections - Ensure all code examples are self-contained and executable
replaced crud_entities for crud_entity
…in cache examples for consistency and correctness
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.
Addressing this issue, points 1 through 7.
These are the changes I've done on the documentation atm.
Added detailed examples for CRUD, API endpoints, exceptions, caching, and rate limiting, improving consistency and dependency injection across docs. Standardized imports, examples, and error handling patterns while updating pagination and database usage to current FastCRUD conventions.
@carlosplanchon gave me a code review. More feedback is appreciated.
Points 8 and 9 of the issue will be addressed shortly.