identity: improve the documentation for Principal.Name() #579
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
Clarify that the must match proof of possession Signed-off-by: Nathan Smith <nathan@chainguard.dev>
Codecov Report
@@ Coverage Diff @@
## main #579 +/- ##
==========================================
- Coverage 44.29% 43.62% -0.68%
==========================================
Files 21 21
Lines 1517 1513 -4
==========================================
- Hits 672 660 -12
- Misses 771 781 +10
+ Partials 74 72 -2
Continue to review full report at Codecov.
|
haydentherapper
approved these changes
May 12, 2022
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.
Summary
Clarifies that Name must match the proof of possession.
@haydentherapper let me know if you can thing of a better name for the method. Happy to add that in here. Thought I'd at least improve the docs while I remembered to.