Skip to content

chore: doc comments on generated Options builders (#124) - #132

Merged
martinkersner merged 1 commit into
mainfrom
issue-124-options-builder-docs
Jul 15, 2026
Merged

chore: doc comments on generated Options builders (#124)#132
martinkersner merged 1 commit into
mainfrom
issue-124-options-builder-docs

Conversation

@martinkersner

Copy link
Copy Markdown
Member

Summary

Regenerated src/generated.rs from datamaxi-codegen with doc comments now emitted on the Options builder setter methods (CexCandleOptions::market, ::interval, ::from, ::to, and 119 more — 123 setters total). The generated Options builders no longer rely on missing_docs suppression.

Generator-side change: Bisonai/datamaxi-codegen#111. Merge that first — this PR is the mechanical regen output.

Diff is purely +123 /// lines in generated.rs; no wire/type/contract changes (tests/generated_contract.rs unchanged).

Note: missing_docs was already absent from the #[allow(...)] on pub mod generated (the issue body predates that); the module stays #[doc(hidden)]. This PR makes the builders carry real docs rather than lean on the hidden-module suppression.

Test plan

  • cargo fmt --check, cargo build --all-features, cargo clippy --all-features — clean
  • cargo test --all-features — 228 passed
  • cargo doc --all-features — no new warnings (9 pre-existing intra-doc-link warnings in hand-written code are unrelated to this change)

Closes #124

Regenerated from datamaxi-codegen with doc comments emitted on Options
builder setters (123 setters now documented). Generated code no longer
relies on missing_docs suppression for the Options builders.

Closes #124
@martinkersner martinkersner self-assigned this Jul 15, 2026
@martinkersner
martinkersner marked this pull request as ready for review July 15, 2026 12:17
@martinkersner
martinkersner merged commit bec800b into main Jul 15, 2026
7 checks passed
@martinkersner
martinkersner deleted the issue-124-options-builder-docs branch July 15, 2026 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

codegen: emit doc comments on generated Options builders

1 participant