Skip to content

Commit 0878752

Browse files
mraszykclaude
andcommitted
docs: Name the field, not the getter, where the value is meant
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 65daccd commit 0878752

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

rs/canonical_state/src/encoding/types.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -738,7 +738,7 @@ impl
738738
// by deleted canisters and does not account for non-deleted canisters.
739739
//
740740
// Starting with `V29`, the reported total is the stored
741-
// `SubnetMetrics::consumed_cycles_total_including_canisters()`, which no
741+
// `SubnetMetrics::consumed_cycles_total_including_canisters`, which no
742742
// longer double counts deleted canisters and does account for the existing
743743
// ones.
744744
let consumed_cycles_total = if certification_version >= CertificationVersion::V29 {

rs/replicated_state/src/metadata_state.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@ impl SubnetMetrics {
587587
/// This is the current computation, which avoids double counting the cycles
588588
/// consumed by deleted canisters, as the legacy
589589
/// [`Self::consumed_cycles_total_v28`] does. It is one of the two summands of
590-
/// [`Self::consumed_cycles_total_including_canisters()`], which is what the
590+
/// [`Self::consumed_cycles_total_including_canisters`], which is what the
591591
/// canonical state consumer reports from certification version `V29` on.
592592
pub fn consumed_cycles_total(&self) -> NominalCycles {
593593
let mut total = NominalCycles::zero();
@@ -677,7 +677,7 @@ impl SubnetMetrics {
677677
/// `consumed_cycles_by_use_case` map, and both are summed here. It is kept
678678
/// unchanged to preserve the certified state for certification versions up
679679
/// to and including `V28`; from `V29` on the consumer reports
680-
/// [`Self::consumed_cycles_total_including_canisters()`], which does not
680+
/// [`Self::consumed_cycles_total_including_canisters`], which does not
681681
/// double count.
682682
pub fn consumed_cycles_total_v28(&self) -> NominalCycles {
683683
let mut total = NominalCycles::zero();

rs/replicated_state/src/metadata_state/tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2786,7 +2786,7 @@ fn consumed_cycles_total_calculates_the_right_amount() {
27862786

27872787
/// The `replicated_state_consumed_cycles_since_replica_started` gauge is set in
27882788
/// `ReplicatedStateMetrics::observe` from
2789-
/// [`SubnetMetrics::consumed_cycles_total_including_canisters()`]. This test
2789+
/// [`SubnetMetrics::consumed_cycles_total_including_canisters`]. This test
27902790
/// exercises every subnet-level use case that contributes to the total, so that
27912791
/// omitting any of them (as the `SchnorrOutcalls`/`VetKd`/`DroppedMessages` use
27922792
/// cases once were) would change the reported value and fail the assertion, plus

0 commit comments

Comments
 (0)