docs: add doc comments to connection types and protocol enums (#99)#102
Merged
martinjms merged 1 commit intoepic/test-doc-passfrom May 2, 2026
Conversation
Adds /// doc comments to all public struct fields, enum variants, and trait methods in crates/arcane-core/src/server_pool.rs (connection types), cluster_simulation.rs, world_simulator.rs, and types.rs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com
This was referenced May 2, 2026
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
Adds
///doc comments to all remaining undocumented public types, fields, and enums inarcane-core:server_pool.rs—ServerHandle,PoolError,PoolErrorCode,PoolStatus,FailureType,ReplacementHandle(connection types and protocol enums)cluster_simulation.rs—ClusterTickContextfields,ClusterSimulation::on_tickworld_simulator.rs—LastKnownState,WorldContext,SimulatedStatefieldstypes.rs—Vec2,Vec3,ClusterGeometryfields,Vec2::new,Vec3::newDecisions made
Test plan
cargo build)cargo test -p arcane-core)cargo fmt --all -- --check)Refs #99