docs(cli): update docs for getStudioEnvironmentVariables #4597
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
rexxars
requested changes
Jun 16, 2023
packages/sanity/src/_internal/cli/server/getStudioEnvironmentVariables.ts
Outdated
Show resolved
Hide resolved
packages/sanity/src/_internal/cli/server/getStudioEnvironmentVariables.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Espen Hovlandsdal <[email protected]>
binoy14
reviewed
Jun 16, 2023
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.
Description
Brush up the tsdoc comments for
getStudioEnvironmentVariablesThe reason why the params obj was moved out into its own interface and exported is due to how some limitations with TSdoc. As it was before there was a huge bulk of text on the
getStudioEnvironmentVariableswhich made it hard to quickly parse through.Now we link to an exported interface (set as public since
getStudioEnvironmentVariablesis also public).What to review
Make sure that the information makes sense. The text itself wasn't changed much from the previous iteration, just an example added and some words shuffled
Notes for release
N/A (Not sure if we want to include this in the release)