collector: Refresh example in doccomment #3292
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
divergentdave
approved these changes
Jul 10, 2024
collector/src/lib.rs
Outdated
| //! HpkeKdfId::HkdfSha256, | ||
| //! HpkeAeadId::Aes128Gcm, | ||
| //! ).unwrap(); | ||
| //! let task_id = TaskId::from_str("[your DAP task ID here]").unwrap(); |
There was a problem hiding this comment.
I'd recommend leaving this un-indented, since the function's opening and closing braces won't appear in the final output. (It's just present to allow us to use .await in this context)
Indeed, but a while ago we decided ago to say "please don't use janus_core directly", so that we can make breaking changes to it. Granted, I don't think we really landed on hard consensus on it, so we can rehash the discussion if we need. #2390 (comment) https://github.com/divviup/janus?tab=readme-ov-file#versioning-and-stability |
inahga
added a commit
that referenced
this pull request
Jul 11, 2024
* collector: Refresh example in doccomment * Remove unnecessary indentation
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.
Give a little bit of love to this doccomment. Suggest use of the
PrivateCollectorCredentialinstead of bringing in the unstablejanus_core. Also provide an example of using a fixed size query.