Refresh API reference docs #8
Merged
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
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the API reference documentation for the Purse library, improving code examples, restructuring API documentation with clearer signatures, and updating MkDocs configuration.
Key Changes:
- Enhanced code example with more realistic usage pattern (button click handler instead of simple toggle call)
- Reformatted all API documentation sections (Methods, Properties, Events) to include explicit type signatures in code blocks
- Removed global MkDocs line numbering and TOC depth configuration in favor of inline settings
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| mkdocs.yml | Removed global toc_depth and pymdownx.highlight settings to support inline configuration |
| docs/api-reference.md | Restructured API documentation with type signatures, improved example code, and moved IsInventoryEmpty from Properties to Methods section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Removed unused Players service from the example. Signed-off-by: Ryan Luu <ryan.luu@ryanluu.dev>
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.
No description provided.