-
Notifications
You must be signed in to change notification settings - Fork 109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Rust module documentation #2050
Merged
Merged
Conversation
This file contains 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
6137dc2
to
1d89177
Compare
09b3a03
to
1256125
Compare
There are still a number of doctest failures that need to be fixed, and some warnings in upstream crates of |
kazimuth
commented
Jan 16, 2025
gefjon
reviewed
Jan 17, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great stuff, thanks!
d79cec7
to
59146bd
Compare
More docs One more patch More table docs More docs Denser sats comments Move comments More doc rewriting Substantial rewrite of main doc slug More links and emphasis Hmm Document macros inline in the bindings crate to make links better Fix some errors in rust module bindings docs + work on schedule documentation Table macro docs polish A day of writing WIP editing TODO on Identity APIs Update BTreeIndex docs Move lifecycle docs to root Move reducer docs again, fix links Minor crate root edits Reducer commentary Edits Finish writing docs Fix links Typo Remove dead docs Typo Fix outdated API More small fixes Add 'Automatic Migrations' section Think incredibly hard.... Weird space More formatting and spacing, use no_run instead of ignore Less passive Fix old names in docs Fix doctests and some comments Document documentation A few more comments Fix all links More comments addressed Kill dead
59146bd
to
5a215fd
Compare
gefjon
approved these changes
Feb 20, 2025
Did this change at some point?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
no runtime change
This change does not affect the final binaries
release-any
To be landed in any release window
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.
Description of Changes
While I'm rewriting the reference, I figured I'd do this as well.
Expected complexity level and risk
0
Testing
Added doctests