chore(docs): use cross-platform example in deno.run jsdoc #14754
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
dsherret
reviewed
May 30, 2022
cli/dts/lib.deno.ns.d.ts
Outdated
| * an array of program arguments, the first of which is the binary. | ||
| * | ||
| * ```ts | ||
| * const p = Deno.run({ | ||
| * cmd: ["echo", "hello"], | ||
| * cmd: ["echo", "hello"], // Use ["pwsh", "-c", "echo", "hello"] on Windows. |
There was a problem hiding this comment.
This seems to suggest that people should use Deno.run with pwsh on Windows. To reduce confusion, it would be good to use a command that works on all three operating systems such as curl.
dsherret
requested changes
May 30, 2022
|
Sure thing, I will rewrite it. |
Indentation is two spaces + 1 from jsdoc... really need jsdoc code formatting.
dsherret
approved these changes
May 30, 2022
bartlomieju
pushed a commit
that referenced
this pull request
Jun 2, 2022
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 changes the
Deno.runJSDoc to use acurlexample that works the same on all the major platforms. Also addsawait p.statusso the program doesn't exit before the output is shown on the terminal.