Add comments to EvaluationVars and methods for better clarity, Add documentation for Range and SelectorsInfo structure #57
+13
−5
Conversation
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
- Documented the `EvaluationVars` struct to describe its purpose and fields. - Added comments for `RemovePrefix` and `GetLocalExtAlgebra` methods explaining their functionality. - Improved code readability and maintainability by providing clear inline documentation.
- Added comments to the `Range` struct explaining its purpose and fields. - Documented the `SelectorsInfo` struct with details about selector indices and groups. - Provided a detailed description for the `NewSelectorsInfo` constructor, including validation logic. - Added a comment to the `NumSelectors` method to clarify its functionality. - Improved code readability and maintainability through comprehensive inline documentation.
Add documentation for Range and SelectorsInfo structures
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.
Add comments to EvaluationVars and methods for better clarit:
EvaluationVarsstruct to describe its purpose and fields.RemovePrefixandGetLocalExtAlgebramethods explaining their functionality.Add documentation for Range and SelectorsInfo structure:
Rangestruct explaining its purpose and fields.SelectorsInfostruct with details about selector indices and groups.NewSelectorsInfoconstructor, including validation logic.NumSelectorsmethod to clarify its functionality.