Skip to content

Commit

Permalink
Enforce wrapping lines at 80 characters with prettier
Browse files Browse the repository at this point in the history
This enforces that all Markdown files are wrapped at 80 characters,
in the style the prettier follows.
  • Loading branch information
pradyunsg committed Jul 30, 2022
1 parent cfea497 commit be51db4
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 20 deletions.
1 change: 1 addition & 0 deletions .prettierrc.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
proseWrap = "always"
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ start or end of a TOML file, which can complicate sending it through a stream.
These details must be negotiated on the application layer.

INI files are frequently compared to TOML for their similarities in syntax and
use as configuration files. However, there is no standardized format for INI
and they do not gracefully handle more than one or two levels of nesting.
use as configuration files. However, there is no standardized format for INI and
they do not gracefully handle more than one or two levels of nesting.

Further reading:

Expand All @@ -82,8 +82,8 @@ Further reading:

## Get Involved

Documentation, bug reports, pull requests, and all other contributions
are welcome!
Documentation, bug reports, pull requests, and all other contributions are
welcome!

## Wiki

Expand All @@ -98,5 +98,5 @@ catalogs the following:
- Encoders
- Converters

Please take a look if you'd like to view or add to that list. Thanks for being
a part of the TOML community!
Please take a look if you'd like to view or add to that list. Thanks for being a
part of the TOML community!
6 changes: 4 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ This section of the repository contains documentation for TOML's maintainers.

## Release Process

- Set up local repos of [toml-lang/toml] and [toml-lang/toml.io], as described in [scripts/release.py](../scripts/release.py).
- In the root of the toml-lang/toml clone, run `python3.8 scripts/release.py <version>`.
- Set up local repos of [toml-lang/toml] and [toml-lang/toml.io], as described
in [scripts/release.py](../scripts/release.py).
- In the root of the toml-lang/toml clone, run
`python3.8 scripts/release.py <version>`.
- Done! ✨

[toml-lang/toml]: https://github.com/toml-lang/toml
Expand Down
26 changes: 14 additions & 12 deletions toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ Unspecified values are invalid.
key = # INVALID
```

There must be a newline (or EOF) after a key/value pair. (See [Inline
Table](#user-content-inline-table) for exceptions.)
There must be a newline (or EOF) after a key/value pair. (See
[Inline Table](#user-content-inline-table) for exceptions.)

```
first = "Tom" last = "Preston-Werner" # INVALID
Expand Down Expand Up @@ -185,8 +185,8 @@ spelling = "favorite"
"spelling" = "favourite"
```

As long as a key hasn't been directly defined, you may still write to it and
to names within it.
As long as a key hasn't been directly defined, you may still write to it and to
names within it.

```
# This makes the key "fruit" into a table.
Expand Down Expand Up @@ -279,8 +279,8 @@ For convenience, some popular characters have a compact escape sequence.
```

Any Unicode character may be escaped with the `\xHH`, `\uHHHH`, or `\UHHHHHHHH`
forms. The escape codes must be valid Unicode [scalar
values](https://unicode.org/glossary/#unicode_scalar_value).
forms. The escape codes must be valid Unicode
[scalar values](https://unicode.org/glossary/#unicode_scalar_value).

All other escape sequences not listed above are reserved; if they are used, TOML
should produce an error.
Expand Down Expand Up @@ -526,8 +526,8 @@ bool2 = false

## Offset Date-Time

To unambiguously represent a specific instant in time, you may use an [RFC
3339](https://tools.ietf.org/html/rfc3339) formatted date-time with offset.
To unambiguously represent a specific instant in time, you may use an
[RFC 3339](https://tools.ietf.org/html/rfc3339) formatted date-time with offset.

```toml
odt1 = 1979-05-27T07:32:00Z
Expand Down Expand Up @@ -591,8 +591,8 @@ ld1 = 1979-05-27

## Local Time

If you include only the time portion of an [RFC
3339](https://tools.ietf.org/html/rfc3339) formatted date-time, it will
If you include only the time portion of an
[RFC 3339](https://tools.ietf.org/html/rfc3339) formatted date-time, it will
represent that time of day without any relation to a specific day or any offset
or timezone.

Expand Down Expand Up @@ -768,7 +768,8 @@ member_since = 1999-08-04

Dotted keys create and define a table for each key part before the last one. Any
such table must have all its key/value pairs defined under the current `[table]`
header, or in the root table if defined before all headers, or in one inline table.
header, or in the root table if defined before all headers, or in one inline
table.

```toml
fruit.apple.color = "red"
Expand Down Expand Up @@ -1020,6 +1021,7 @@ When transferring TOML files over the internet, the appropriate MIME type is

## ABNF Grammar

A formal description of TOML's syntax is available, as a separate [ABNF file][abnf].
A formal description of TOML's syntax is available, as a separate [ABNF
file][abnf].

[abnf]: ./toml.abnf

3 comments on commit be51db4

@tuckstarrydell
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commit

@tuckstarrydell
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tuckstarrydell
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.