chore: Add comments to SignerEntries.h #5059
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
scottschurr
added
Tech Debt
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5059 +/- ##
=========================================
- Coverage 71.4% 71.4% -0.0%
=========================================
Files 796 796
Lines 67031 67031
Branches 10865 10864 -1
=========================================
- Hits 47832 47831 -1
- Misses 19199 19200 +1
... and 3 files with indirect coverage changes |
ximinez
approved these changes
Jul 24, 2024
|
@scottschurr I agree that this PR is trivial, and I've approved it. If it's ready for merge, please add the "Passed" label or add a comment to that effect. |
scottschurr
added
the
Passed
intelliot
approved these changes
Jul 25, 2024
vlntb
pushed a commit
to vlntb/rippled
that referenced
this pull request
Aug 23, 2024
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.
High Level Overview of Change
The
SignerEntriesclass was not particularly well documented. This pull request adds a few comments to that class. The class might be confusing to some folks without the additional comments.While I was in there I changed one parameter from
std::string const&tostd::string_viewwhich might be a tiny performance boost. It avoids constructing astd::stringfrom achar const*at the call sites.Type of Change