docs: improve API documentation for library consumers#5
Merged
Conversation
- Enable compile-testing on Differentiable doc examples (was `ignore`) - Document Send+Sync requirement on ReverseRule and ForwardRule traits - Add Wirtinger/CR-calculus convention section for complex scalars - Document rrule first-argument convention (result vs input x) - Clarify result vs x parameter on individual rrule functions - Add Getting Started section to README with dependency and usage examples Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
shinaoka
force-pushed
the
docs/improve-api-documentation
branch
from
042f352 to
7e0323d
Compare
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
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.
Summary
Differentiabledoc examples (previously/// ```ignore)Send + Syncrequirement onReverseRuleandForwardRuletraitsx)resultvsxparameter on individual rrule function doc commentsMotivated by a simulated downstream-user feature test that found these documentation gaps.
Test plan
cargo fmt --all— no changescargo clippy --workspace— cleancargo test --doc --release --workspace— 38 passed (previouslyignored examples now compile-tested)cargo nextest run --release --workspace— 69 passed🤖 Generated with Claude Code