diff options
| author | Kitson Kelly <me@kitsonkelly.com> | 2022-10-27 00:53:48 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-26 15:53:48 +0200 |
| commit | a0d10efbb1acffe203c42a4f6133ba5af0dcef18 (patch) | |
| tree | 32a6f47dc717164988dce783dfa73a13d24bc702 /cli/tests | |
| parent | 5d45d2a7e0f5fef6323adcdda40fdadf7b1e87ad (diff) | |
chore: improve built-in API documentation (#16158)
Co-authored-by: crowlkats <crowlkats@toaxl.com>
Co-authored-by: Colin Ihrig <cjihrig@gmail.com>
Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
Diffstat (limited to 'cli/tests')
| -rw-r--r-- | cli/tests/integration/lsp_tests.rs | 2 | ||||
| -rw-r--r-- | cli/tests/testdata/lsp/completion_resolve_response.json | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/cli/tests/integration/lsp_tests.rs b/cli/tests/integration/lsp_tests.rs index 9a0d407df..38d44b51f 100644 --- a/cli/tests/integration/lsp_tests.rs +++ b/cli/tests/integration/lsp_tests.rs @@ -935,7 +935,7 @@ fn lsp_hover() { "language": "typescript", "value": "const Deno.args: string[]" }, - "Returns the script arguments to the program. If for example we run a\nprogram:\n\ndeno run --allow-read https://deno.land/std/examples/cat.ts /etc/passwd\n\nThen `Deno.args` will contain:\n\n[ \"/etc/passwd\" ]", + "Returns the script arguments to the program.\n\nGive the following command line invocation of Deno:\n\n```sh\ndeno run --allow-read https://deno.land/std/examples/cat.ts /etc/passwd\n```\n\nThen `Deno.args` will contain:\n\n```\n[ \"/etc/passwd\" ]\n```\n\nIf you are looking for a structured way to parse arguments, there is the\n[`std/flags`](https://deno.land/std/flags) module as part of the Deno\nstandard library.", "\n\n*@category* - Runtime Environment", ], "range": { diff --git a/cli/tests/testdata/lsp/completion_resolve_response.json b/cli/tests/testdata/lsp/completion_resolve_response.json index d223fd7f0..034a4781f 100644 --- a/cli/tests/testdata/lsp/completion_resolve_response.json +++ b/cli/tests/testdata/lsp/completion_resolve_response.json @@ -4,7 +4,7 @@ "detail": "const Deno.build: {\n target: string;\n arch: \"x86_64\" | \"aarch64\";\n os: \"darwin\" | \"linux\" | \"windows\";\n vendor: string;\n env?: string | undefined;\n}", "documentation": { "kind": "markdown", - "value": "Build related information.\n\n*@category* - Runtime Environment" + "value": "Information related to the build of the current Deno runtime.\n\nUsers are discouraged from code branching based on this information, as\nassumptions about what is available in what build environment might change\nover time. Developers should specifically sniff out the features they\nintend to use.\n\nThe intended use for the information is for logging and debugging purposes.\n\n*@category* - Runtime Environment" }, "sortText": "1", "insertTextFormat": 1 |