secp256k1: Tighten max magnitudes in comments. #3442
Merged
Conversation
This file contains 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
davecgh
added
the
documentation
jrick
approved these changes
Sep 9, 2024
The FieldVal type was originally an internal only type and the comments regarding the magnitudes were written from that perspective along with the the understanding that the stated maximum magnitudes referred to the max results during normalization. However, now that the type is external, it was pointed out that the magnitude comments are misleading since it is not explicitly made clear anywhere that they refer to what ultimately happens during normalization as opposed to the specific methods in question. In order to prevent potential confusion, this updates all of the comments regarding max magnitudes to be framed in terms of an external perspective and the specific method they are commenting on such that it ultimately ensures normalization is guaranteed not to exceed that actual internal maximum magnitude.
davecgh
force-pushed
the
secp256k1_clarify_magnitudes
branch
from
4bd8c60
to
7b6403e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
FieldValtype was originally an internal only type and the comments regarding the magnitudes were written from that perspective along with the the understanding that the stated maximum magnitudes referred to the max results during normalization.However, now that the type is external, it was pointed out that the magnitude comments are misleading since it is not explicitly made clear anywhere that they refer to what ultimately happens during normalization as opposed to the specific methods in question.
In order to prevent potential confusion, this updates all of the comments regarding max magnitudes to be framed in terms of an external perspective and the specific method they are commenting on such that it ultimately ensures normalization is guaranteed not to exceed that actual internal maximum magnitude.