Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak collections docs to make CLI usage clearer #602

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

josephjclark
Copy link
Contributor

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!):

  • Code generation (copilot but not intellisense)
  • Learning or fact checking
  • Strategy / design
  • Optimisation / refactoring
  • Translation / spellchecking / doc gen
  • Other
  • I have not used AI

You can read more details in our
Responsible AI Policy

@@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a second tweak after speaking with Benson today

@josephjclark
Copy link
Contributor Author

Hey @christad92 can I ask you to take a look at this and merge it? It's a response to your comments about that collections token

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

1 participant