Standardise placeholders #161
Open
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
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 PR standardises how we use placeholders for API token and dataset name in code samples.
Previously, we had many different versions of these placeholders. This was inconsistent and confusing. This PR resolves this issue by using the following placeholders throughout the docs:
{api_token},{dataset_name}.Note that these placeholders always represent a string. Declared variable names and environment variable names (such as
AXIOM_API_TOKEN = "string"aren't changed. The reason is that they are often hard-coded in the SDKs and integrations, and changing them in the code samples could break things.