From 44477596eda3ca50ea6597d4af1fd809a01e2bdc Mon Sep 17 00:00:00 2001 From: Robin Wieruch Date: Tue, 26 May 2020 16:08:23 +0200 Subject: [PATCH] improve docs (#5872) --- docs/examples/tcp_echo.md | 4 ++-- docs/getting_started.md | 2 +- docs/getting_started/first_steps.md | 13 ++++++------- docs/runtime/compiler_apis.md | 2 +- docs/tools/debugger.md | 8 ++++---- 5 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/examples/tcp_echo.md b/docs/examples/tcp_echo.md index 360c5faccd..5dfc71b831 100644 --- a/docs/examples/tcp_echo.md +++ b/docs/examples/tcp_echo.md @@ -1,7 +1,7 @@ ## TCP echo server -This is an example of a simple server which accepts connections on port 8080, -and returns to the client anything it sends. +This is an example of a server which accepts connections on port 8080, and +returns to the client anything it sends. ```ts const listener = Deno.listen({ port: 8080 }); diff --git a/docs/getting_started.md b/docs/getting_started.md index 7737f08d74..b2b0eb8639 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -4,7 +4,7 @@ In this chapter we'll discuss: - Installing Deno - Setting up your environment -- Running a simple `Hello World` script +- Running a `Hello World` script - Writing our own script - Understanding permissions - Using Deno with TypeScript diff --git a/docs/getting_started/first_steps.md b/docs/getting_started/first_steps.md index 9186af7302..4a551c4156 100644 --- a/docs/getting_started/first_steps.md +++ b/docs/getting_started/first_steps.md @@ -1,7 +1,6 @@ ## First steps -This page contains some simple examples to teach you about the fundamentals of -Deno. +This page contains some examples to teach you about the fundamentals of Deno. This document assumes that you have some prior knowledge of JavaScript, especially about `async`/`await`. If you have no prior knowledge of JavaScript, @@ -14,8 +13,8 @@ before attempting to start with Deno. Deno is a runtime for JavaScript/TypeScript which tries to be web compatible and use modern features wherever possible. -Browser compatibility means a simple `Hello World` program in Deno is the same -as the one you can run in the browser: +Browser compatibility means a `Hello World` program in Deno is the same as the +one you can run in the browser: ```ts console.log("Welcome to Deno 🦕"); @@ -106,10 +105,10 @@ Try the program: deno run --allow-read https://deno.land/std/examples/cat.ts /etc/passwd ``` -### A simple TCP server +### TCP server -This is an example of a simple server which accepts connections on port 8080, -and returns to the client anything it sends. +This is an example of a server which accepts connections on port 8080, and +returns to the client anything it sends. ```ts const hostname = "0.0.0.0"; diff --git a/docs/runtime/compiler_apis.md b/docs/runtime/compiler_apis.md index ebb14f6b3c..c2d2348360 100644 --- a/docs/runtime/compiler_apis.md +++ b/docs/runtime/compiler_apis.md @@ -52,7 +52,7 @@ const [diagnostics, emitMap] = await Deno.compile( ); ``` -In this case `emitMap` will contain a simple `console.log()` statement. +In this case `emitMap` will contain a `console.log()` statement. ### `Deno.bundle()` diff --git a/docs/tools/debugger.md b/docs/tools/debugger.md index e9eccb6f02..5725d029a2 100644 --- a/docs/tools/debugger.md +++ b/docs/tools/debugger.md @@ -14,9 +14,9 @@ first line of code. ### Chrome Devtools -Let's try debugging simple program using Chrome Devtools; for this purpose we'll -use [file_server.ts](https://deno.land/std@v0.50.0/http/file_server.ts) from -`std`; a simple static file server. +Let's try debugging a program using Chrome Devtools; for this purpose we'll use +[file_server.ts](https://deno.land/std@v0.50.0/http/file_server.ts) from `std`; +a static file server. Use `--inspect-brk` flag to break execution on the first line. @@ -83,7 +83,7 @@ Deno can be debugged using VSCode. Official support in plugin is being worked on - https://github.com/denoland/vscode_deno/issues/12 -We can still attach debugger by manually providing simple `launch.json` config: +We can still attach debugger by manually providing a `launch.json` config: ```json {