crypto: add some more documentation to DeviceKeys
#4537
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
This confused me for a while, so I thought more documentation might help.
richvdh
requested review from
bnjbvr and
BillCarsonFr
and removed request for
a team
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4537 +/- ##
=======================================
Coverage 85.42% 85.43%
=======================================
Files 285 285
Lines 32112 32112
=======================================
+ Hits 27433 27434 +1
+ Misses 4679 4678 -1 ☔ View full report in Codecov by Sentry. |
bnjbvr
approved these changes
Jan 16, 2025
Comment on lines
+199
to
+200
| /// A de/serialization helper for [`DeviceKeys`] which maps the `keys` to/from | ||
| /// [`DeviceKey`]s. |
There was a problem hiding this comment.
very light suggestion: One of the two mentions to DeviceKey seems redundant; you get to choose which one :D
There was a problem hiding this comment.
one is a mention of DeviceKey, the other DeviceKeys. They are quite different!
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.
This confused me for a while, so I thought more documentation might help.