Fix spacing for cURL code samples #26706
Closed
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.
Why:
The cURL code samples in the API docs are missing a space before the escape character on the authorization header line. This can cause confusion if you copy/paste the code snippet and get an unexpected error.
Closes issue #26708.
What's being changed (if available, include any code snippets, screenshots, or gifs):
The authorization header line in the cURL code samples will now have a space before the backslash escape character at the end of the line:
-H "Authorization: Bearer <YOUR-TOKEN>"\
-->-H "Authorization: Bearer <YOUR-TOKEN>" \
This allows users to copy/paste the command without errors.
Screenshots
Before:
After:
Alternate Solution
Alternatively, you could split the args on line 91, and let
${args.join(' \\\n ')}
on line 96 join them with the proper spacing, escape characters, and newlines. I've created a branch with those changes if that is the preferred direction.Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.
data
directory.For content changes, I have completed the self-review checklist.