Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Renames WeightMeter constructors for better readability #1186

Merged
merged 5 commits into from
Sep 1, 2023
Merged

Renames WeightMeter constructors for better readability #1186

merged 5 commits into from
Sep 1, 2023

Conversation

gupnik
Copy link
Contributor

@gupnik gupnik commented Aug 26, 2023

As discussed in the Elements chat, this PR adds the following changes:

  1. Renames WeightMeter::max_limit() to WeightMeter::new() as the maximum weight limit is implied
  2. Renames WeightMeter::from_limit() to WeightMeter::with_limit()

@gupnik gupnik added A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). T1-FRAME This PR/Issue is related to core FRAME, the framework. D0-easy Can be fixed primarily by duplicating and adapting code by an intermediate coder. labels Aug 26, 2023
@gupnik gupnik requested a review from ggwpez August 26, 2023 06:00
@paritytech-ci paritytech-ci requested review from a team August 26, 2023 06:00
bkchr
bkchr reviewed Aug 26, 2023
View reviewed changes
substrate/primitives/weights/src/weight_meter.rs
Self { consumed: Weight::zero(), limit }
}

/// Creates [`Self`] with the maximal possible limit for the consumable weight.
pub fn max_limit() -> Self {
Self::from_limit(Weight::MAX)
pub fn new() -> Self {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But the old one was more expressive?

Copy link
Contributor Author

@gupnik gupnik Aug 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comes after a discussion with @gavofyork around the readability of this piece of code:

let meter = WeightMeter::max_limit();
meter.consume(some_weight);

It reads as though the meter starts from the limit and should saturate with the further consume call. Going through the impl makes it clear that it still starts from 0.

Since the limit to max is implied with a meter, we should not need to specify it explicitly.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe with_max_limit? I mean your example is understandable, but new is still not really expressive to what the limit will be. (I will also not block on this, just some thought)

@paritytech-ci paritytech-ci requested review from a team August 26, 2023 16:06
bkchr
bkchr approved these changes Aug 28, 2023
View reviewed changes
substrate/primitives/weights/src/weight_meter.rs
Self { consumed: Weight::zero(), limit }
}

/// Creates [`Self`] with the maximal possible limit for the consumable weight.
pub fn max_limit() -> Self {
Self::from_limit(Weight::MAX)
pub fn new() -> Self {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe with_max_limit? I mean your example is understandable, but new is still not really expressive to what the limit will be. (I will also not block on this, just some thought)

@paritytech-ci paritytech-ci requested a review from a team August 28, 2023 09:35
ordian
ordian approved these changes Aug 31, 2023
View reviewed changes
Copy link
Member

@ordian ordian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(approve to unblock the merge)

@gupnik gupnik merged commit 16fe5be into master Sep 1, 2023
4 checks passed
@gupnik gupnik deleted the gupnik/weight-meter-update branch September 1, 2023 06:46
ordian added a commit that referenced this pull request Sep 1, 2023
@ordian
Merge branch 'master' into s0me0ne/candidate-session-index
40e3da9 
* master: (25 commits)
  fix typos (#1339)
  Use bandersnatch-vrfs with locked dependencies ref (#1342)
  Bump bs58 from 0.4.0 to 0.5.0 (#1293)
  Contracts: `seal0::balance` should return the free balance (#1254)
  Logs: add extra debug log for negative rep changes (#1205)
  Added short-benchmarks for cumulus (#1183)
  [xcm-emulator] Improve hygiene and clean up (#1301)
  Bump the known_good_semver group with 1 update (#1347)
  Renames API (#1186)
  Rename `polkadot-parachain` to `polkadot-parachain-primitives` (#1334)
  Add README to project root (#1253)
  Add environmental variable to track decoded instructions (#1320)
  Fix polkadot-node-core-pvf-prepare-worker build with jemalloc (#1315)
  Sassafras primitives (#1249)
  Restructure `dispatch` macro related exports (#1162)
  backing: move the min votes threshold to the runtime (#1200)
  Bump zstd from 0.11.2+zstd.1.5.2 to 0.12.4 (#1326)
  Remove `substrate_test_utils::test` (#1321)
  remove disable-runtime-api (#1328)
  [ci] add more jobs for pipeline cancel, cleanup (#1314)
  ...
Daanvdplas pushed a commit that referenced this pull request Sep 11, 2023
@gupnik @pepoviola @Daanvdplas
Renames API (#1186)
0ac41b8 
Co-authored-by: Javier Viola <javier@parity.io>
@crystalin crystalin mentioned this pull request Oct 20, 2023
Closed
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this pull request Mar 25, 2024
@gupnik @pepoviola
Renames API (paritytech#1186)
a54d7e3 
Co-authored-by: Javier Viola <javier@parity.io>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
88122ce 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
3d2cbc1 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
85947fe 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
63d0ec7 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
5919386 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
ff9e940 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
b471cd6 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
67128e4 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
813f093 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
8770500 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 10, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
d46be6f 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 10, 2024
@boundless-forest @serban300
Expose some const value and type (paritytech#1186)
65bfdd2 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
bkchr pushed a commit that referenced this pull request Apr 10, 2024
@boundless-forest @bkchr
Expose some const value and type (#1186)
4812160 
* change const value visable

* Add docs

* Update docs

* Update docs 2

* Fix ci

* Fix spell check
This was referenced Jun 5, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ggwpez ggwpez ggwpez approved these changes

@bkchr bkchr bkchr approved these changes

@ordian ordian ordian approved these changes

Assignees
No one assigned
Labels
A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). D0-easy Can be fixed primarily by duplicating and adapting code by an intermediate coder. T1-FRAME This PR/Issue is related to core FRAME, the framework.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@gupnik @ordian @bkchr @ggwpez @pepoviola