docs: add doc comments to IClusteringModel and related types (#97)#100
Merged
martinjms merged 1 commit intoepic/test-doc-passfrom May 2, 2026
Conversation
Adds /// doc comments to all public types and their fields in crates/arcane-core/src/clustering_model.rs: WorldStateView, ClusterInfo, PlayerInfo, ClusterDecision, DecisionType, DecisionReason, ModelInfo, and ValidationResult. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
Add missing
///doc comments to all public types and their fields incrates/arcane-core/src/clustering_model.rs— theIClusteringModeltrait and its associated data types.Decisions made
None — work was a literal implementation of the issue spec. Every field comment describes what the field represents, sourced from the architecture doc (IF-01) and the existing code.
Test plan
cargo build -p arcane-core)cargo test -p arcane-core)cargo fmt --all -- --check)cargo doc --no-deps -p arcane-core)Refs #97