Tweak collections docs to make CLI usage clearer #602
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
josephjclark
commented
Nov 15, 2024
| @@ -102,7 +102,9 @@ collections.each( | |||
| ); | |||
| ``` | |||
|
|
|||
| New values are uploaded to a collection through `collections.set`: | |||
| Values are uploaded to a collection through `collections.set`. All sets are "upserts" - meaning that new keys will be created for values that don't exist, and values will be updated for keys that _do_ exist. | |||
There was a problem hiding this comment.
Added a second tweak after speaking with Benson today
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.
Short Description
@christad92 quite rightly points out that collections docs for CLI usage are a bit confusing. What is a
collections_token?This PR updates the sample code to make it a little clearer that a PAT is used as a collections_token
AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to
know!):
You can read more details in our
Responsible AI Policy