docs: Enhance Edwards Curve Documentation and Test Readability #1903
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.
Motivation
The Edwards curve implementation in the codebase, while functionally sound, had areas where documentation could be enhanced to improve developer experience. Clear and comprehensive documentation is crucial for maintaining code quality and helping new contributors understand the codebase better.
Specifically, the
EdwardsParameters
trait and its associated methods lacked detailed documentation, making it potentially challenging for new developers to understand the purpose and usage of these important components.Additionally, the test module used single-letter type aliases, which, while functional, didn't follow Rust's best practices for code readability.
Solution
This PR implements two main improvements:
Added comprehensive documentation to the
EdwardsParameters
trait and its methods:D
constantgenerator()
andprime_group_order()
methodsEnhanced test code readability:
E
with more descriptiveEdwardsCurve
These changes make the codebase more maintainable and accessible while adhering to Rust documentation best practices.
PR Checklist