Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: end sentences with a period in markdown #7813

Merged
merged 1 commit into from
Oct 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: end sentences with a period in markdown
  • Loading branch information
trivikr committed Oct 3, 2020
commit e33e06b5cb45a635cf15357ad554e0eac268ab12
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Deno is a _simple_, _modern_ and _secure_ runtime for **JavaScript** and
- Built-in utilities like a dependency inspector (deno info) and a code
formatter (deno fmt).
- Set of reviewed standard modules that are guaranteed to work with
[Deno](https://deno.land/std/)
[Deno](https://deno.land/std/).

### Install

Expand Down Expand Up @@ -76,14 +76,14 @@ for await (const req of s) {
You can find a more in depth introduction, examples, and environment setup
guides in the [manual](https://deno.land/manual).

More in-depth info can be found in the runtime [documentation](doc.deno.land)
More in-depth info can be found in the runtime [documentation](doc.deno.land).

### Contributing

We appreciate your help!

To contribute, please read the our
[guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)
[guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md).

[Build Status - Cirrus]: https://github.com/denoland/deno/workflows/ci/badge.svg?branch=master&event=push
[Build status]: https://github.com/denoland/deno/actions
Expand Down
4 changes: 2 additions & 2 deletions Releases.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Releases

Binary releases can be downloaded manually at
Binary releases can be downloaded manually at:
https://github.com/denoland/deno/releases

We also have one-line install commands at
We also have one-line install commands at:
https://github.com/denoland/deno_install

### 1.4.4 / 2020.10.03
Expand Down
4 changes: 2 additions & 2 deletions cli/dts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ currently (unfortunately) have a rather manual process for upgrading TypeScript.
It works like this currently:

1. Checkout typescript repo in a seperate directory.
2. Copy typescript.js into Deno repo
3. Copy d.ts files into dts directory
2. Copy typescript.js into Deno repo.
3. Copy d.ts files into dts directory.

So that might look something like this:

Expand Down
20 changes: 10 additions & 10 deletions cli/rt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,38 +22,38 @@ Some Web APIs are using ops under the hood, eg. `console`, `performance`.
## Implemented Web APIs

- [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob): for
representing opaque binary data
representing opaque binary data.
- [Console](https://developer.mozilla.org/en-US/docs/Web/API/Console): for
logging purposes
logging purposes.
- [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent),
[EventTarget](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget)
and
[EventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventListener):
to work with DOM events
to work with DOM events.
- **Implementation notes:** There is no DOM hierarchy in Deno, so there is no
tree for Events to bubble/capture through.
- [fetch](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch),
[Request](https://developer.mozilla.org/en-US/docs/Web/API/Request),
[Response](https://developer.mozilla.org/en-US/docs/Web/API/Response),
[Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) and
[Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers): modern
Promise-based HTTP Request API
Promise-based HTTP Request API.
- [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData): access
to a `multipart/form-data` serialization
to a `multipart/form-data` serialization.
- [Performance](https://developer.mozilla.org/en-US/docs/Web/API/Performance):
retrieving current time with a high precision
retrieving current time with a high precision.
- [setTimeout](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout),
[setInterval](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setInterval),
[clearTimeout](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/clearTimeout):
scheduling callbacks in future and
[clearInterval](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/clearInterval)
[clearInterval](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/clearInterval).
- [Stream](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) for
creating, composing, and consuming streams of data
creating, composing, and consuming streams of data.
- [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) and
[URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams):
to construct and parse URLSs
to construct and parse URLSs.
- [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker): executing
additional code in a separate thread
additional code in a separate thread.
- **Implementation notes:** Blob URLs are not supported, object ownership
cannot be transferred, posted data is serialized to JSON instead of
[structured cloning](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm).
16 changes: 8 additions & 8 deletions cli/tests/unit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ unitTest({
`unitTest` is is a wrapper function that enhances `Deno.test()` API in several
ways:

- ability to conditionally skip tests using `UnitTestOptions.skip`
- ability to conditionally skip tests using `UnitTestOptions.skip`.
- ability to register required set of permissions for given test case using
`UnitTestOptions.perms`
`UnitTestOptions.perms`.
- sanitization of resources - ensuring that tests close all opened resources
preventing interference between tests
preventing interference between tests.
- sanitization of async ops - ensuring that tests don't leak async ops by
ensuring that all started async ops are done before test finishes
ensuring that all started async ops are done before test finishes.

## Running tests

Expand All @@ -50,21 +50,21 @@ There are three ways to run `unit_test_runner.ts`:
target/debug/deno run -A cli/tests/unit/unit_test_runner.ts --master

# By default all output of worker processes is discarded; for debug purposes
# the --verbose flag preserves output from the worker
# the --verbose flag preserves output from the worker.
target/debug/deno run -A cli/tests/unit/unit_test_runner.ts --master --verbose

# Run subset of tests that don't require any permissions
# Run subset of tests that don't require any permissions.
target/debug/deno run --unstable cli/tests/unit/unit_test_runner.ts

# Run subset tests that require "net" and "read" permissions
# Run subset tests that require "net" and "read" permissions.
target/debug/deno run --unstable --allow-net --allow-read cli/tests/unit/unit_test_runner.ts

# "worker" mode communicates with parent using TCP socket on provided address;
# after initial setup drops permissions to specified set. It shouldn't be used
# directly, only be "master" process.
target/debug/deno run -A cli/tests/unit/unit_test_runner.ts --worker --addr=127.0.0.1:4500 --perms=net,write,run

# Run specific tests
# Run specific tests.
target/debug/deno run --unstable --allow-net cli/tests/unit/unit_test_runner.ts -- netTcpListenClose

RUST_BACKTRACE=1 cargo run -- run --unstable --allow-read --allow-write cli/tests/unit/unit_test_runner.ts -- netUnixDialListen
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Before submitting, please make sure the following is done:
1. That there is a related issue and it is referenced in the PR text.
2. There are tests that cover the changes.
3. Ensure `cargo test` passes.
4. Format your code with `./tools/format.py`
4. Format your code with `./tools/format.py`.
5. Make sure `./tools/lint.py` passes.

## Changes to `third_party`
Expand Down Expand Up @@ -69,4 +69,4 @@ and are denoted by a leading `/**` before terminating with a `*/`. For example:
export const FOO = "foo";
```

Find more at https://jsdoc.app/
Find more at: https://jsdoc.app/
2 changes: 1 addition & 1 deletion op_crates/web/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# deno web

Op crate that implements Event, TextEncoder, TextDecoder
Op crate that implements Event, TextEncoder, TextDecoder.
6 changes: 3 additions & 3 deletions std/archive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ await tar.append("deno.txt", {
contentSize: content.byteLength,
});

// Or specifying a filePath
// Or specifying a filePath.
await tar.append("land.txt", {
filePath: "./land.txt",
});

// use tar.getReader() to read the contents
// use tar.getReader() to read the contents.

const writer = await Deno.open("./out.tar", { write: true, create: true });
await Deno.copy(tar.getReader(), writer);
Expand Down Expand Up @@ -53,7 +53,7 @@ for await (const entry of untar) {

await ensureFile(entry.fileName);
const file = await Deno.open(entry.fileName, { write: true });
// <entry> is a reader
// <entry> is a reader.
await Deno.copy(entry, file);
}
reader.close();
Expand Down
6 changes: 3 additions & 3 deletions std/async/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ async is a module to provide help with aysncronous tasks.

# usage

The following functions and class are exposed in `mod.ts`
The following functions and class are exposed in `mod.ts`:

## deferred

Creates a Promise with the `reject` and `resolve` functions.
Create a Promise with the `reject` and `resolve` functions.

```typescript
import { deferred } from "https://deno.land/std/async/mod.ts";
Expand All @@ -20,7 +20,7 @@ p.resolve(42);

## delay

Resolve a Promise after a given amount of milliseconds
Resolve a Promise after a given amount of milliseconds.

```typescript
import { delay } from "https://deno.land/std/async/mod.ts";
Expand Down
2 changes: 1 addition & 1 deletion std/bytes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ bytes module is made to provide helpers to manipulation of bytes slice.

# usage

All the following functions are exposed in `mod.ts`
All the following functions are exposed in `mod.ts`.

## findIndex

Expand Down
48 changes: 24 additions & 24 deletions std/datetime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,29 @@ The following symbols from
[unicode LDML](http:https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table)
are supported:

- `yyyy` - numeric year
- `yy` - 2-digit year
- `M` - numeric month
- `MM` - 2-digit month
- `d` - numeric day
- `dd` - 2-digit day

- `H` - numeric hour (0-23 hours)
- `HH` - 2-digit hour (00-23 hours)
- `h` - numeric hour (1-12 hours)
- `hh` - 2-digit hour (01-12 hours)
- `m` - numeric minute
- `mm` - 2-digit minute
- `s` - numeric second
- `ss` - 2-digit second
- `S` - 1-digit fractionalSecond
- `SS` - 2-digit fractionalSecond
- `SSS` - 3-digit fractionalSecond

- `a` - dayPeriod, either `AM` or `PM`

- `'foo'` - quoted literal
- `./-` - unquoted literal
- `yyyy` - numeric year.
- `yy` - 2-digit year.
- `M` - numeric month.
- `MM` - 2-digit month.
- `d` - numeric day.
- `dd` - 2-digit day.

- `H` - numeric hour (0-23 hours).
- `HH` - 2-digit hour (00-23 hours).
- `h` - numeric hour (1-12 hours).
- `hh` - 2-digit hour (01-12 hours).
- `m` - numeric minute.
- `mm` - 2-digit minute.
- `s` - numeric second.
- `ss` - 2-digit second.
- `S` - 1-digit fractionalSecond.
- `SS` - 2-digit fractionalSecond.
- `SSS` - 3-digit fractionalSecond.

- `a` - dayPeriod, either `AM` or `PM`.

- `'foo'` - quoted literal.
- `./-` - unquoted literal.

### parse

Expand Down Expand Up @@ -78,7 +78,7 @@ dayOfYear(new Date("2019-03-11T03:24:00")); // output: 70

### weekOfYear

Returns the ISO week number of the provided date (1-53)
Returns the ISO week number of the provided date (1-53).

```ts
import { weekOfYear } from "https://deno.land/std/datetime/mod.ts";
Expand Down
22 changes: 11 additions & 11 deletions std/encoding/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ function is as follows:

##### `ReadOptions`

- **`comma?: string;`**: Character which separates values. Default: `','`
- **`comment?: string;`**: Character to start a comment. Default: `'#'`
- **`comma?: string;`**: Character which separates values. Default: `','`.
- **`comment?: string;`**: Character to start a comment. Default: `'#'`.
- **`trimLeadingSpace?: boolean;`**: Flag to trim the leading space of the
value. Default: `false`
value. Default: `false`.
- **`lazyQuotes?: boolean;`**: Allow unquoted quote in a quoted field or non
double quoted quotes in quoted field. Default: 'false`
double quoted quotes in quoted field. Default: `false`.
- **`fieldsPerRecord?`**: Enabling the check of fields for each row. If == 0,
first row is used as referral for the number of fields.

Expand Down Expand Up @@ -226,9 +226,9 @@ console.log(tomlObject);

## YAML

YAML parser / dumper for Deno
YAML parser / dumper for Deno.

Heavily inspired from [js-yaml]
Heavily inspired from [js-yaml].

### Basic usage

Expand Down Expand Up @@ -294,17 +294,17 @@ Serializes `object` as a YAML document.

### :warning: Limitations

- `binary` type is currently not stable
- `function`, `regexp`, and `undefined` type are currently not supported
- `binary` type is currently not stable.
- `function`, `regexp`, and `undefined` type are currently not supported.

### More example

See https://github.com/nodeca/js-yaml.
See: https://github.com/nodeca/js-yaml

## base32

[RFC4648 base32](https://tools.ietf.org/html/rfc4648#section-6) encoder/decoder
for Deno
for Deno.

### Basic usage

Expand All @@ -326,7 +326,7 @@ console.log(encode(binaryData));

## ascii85

Ascii85/base85 encoder and decoder with support for multiple standards
Ascii85/base85 encoder and decoder with support for multiple standards.

### Basic usage

Expand Down
12 changes: 6 additions & 6 deletions std/flags/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# flags

Command line arguments parser for Deno based on minimist
Command line arguments parser for Deno based on minimist.

# Example

Expand Down Expand Up @@ -42,15 +42,15 @@ Any arguments after `'--'` will not be parsed and will end up in `parsedArgs._`.
options can be:

- `options.string` - a string or array of strings argument names to always treat
as strings
as strings.
- `options.boolean` - a boolean, string or array of strings to always treat as
booleans. if `true` will treat all double hyphenated arguments without equal
signs as boolean (e.g. affects `--foo`, not `-f` or `--foo=bar`)
signs as boolean (e.g. affects `--foo`, not `-f` or `--foo=bar`).
- `options.alias` - an object mapping string names to strings or arrays of
string argument names to use as aliases
- `options.default` - an object mapping string argument names to default values
string argument names to use as aliases.
- `options.default` - an object mapping string argument names to default values.
- `options.stopEarly` - when true, populate `parsedArgs._` with everything after
the first non-option
the first non-option.
- `options['--']` - when true, populate `parsedArgs._` with everything before
the `--` and `parsedArgs['--']` with everything after the `--`. Here's an
example:
Expand Down
Loading