Skip to content
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 9 commits into from
Feb 21, 2025
Merged

Update Rust module documentation #2050

merged 9 commits into from
Feb 21, 2025

Conversation

kazimuth
Copy link
Contributor

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

@kazimuth
Copy link
Contributor Author

There are still a number of doctest failures that need to be fixed, and some warnings in upstream crates of bindings as well, but I'm opening this up for textual review now.

@kazimuth kazimuth marked this pull request as ready for review January 15, 2025 18:11
@kazimuth kazimuth requested review from gefjon and joshua-spacetime and removed request for joshua-spacetime January 15, 2025 19:39
Copy link
Contributor

@gefjon gefjon left a 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!

@bfops bfops added release-any To be landed in any release window no runtime change This change does not affect the final binaries labels Jan 21, 2025
@kazimuth kazimuth force-pushed the jgilles/rust-docs-update branch 2 times, most recently from d79cec7 to 59146bd Compare February 14, 2025 18:37
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
@kazimuth kazimuth force-pushed the jgilles/rust-docs-update branch from 59146bd to 5a215fd Compare February 19, 2025 19:21
@gefjon gefjon self-assigned this Feb 20, 2025
@gefjon gefjon enabled auto-merge February 20, 2025 19:50
@gefjon gefjon added this pull request to the merge queue Feb 21, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 21, 2025
@gefjon gefjon added this pull request to the merge queue Feb 21, 2025
Merged via the queue into master with commit 8a31704 Feb 21, 2025
14 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants