Skip to content

Commit

Permalink
Linking yaml v2 library in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesbraza committed Oct 2, 2023
1 parent fd5c0af commit 2180c98
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Currently, there is only a `basic` formatter, however there is full support for

## Basic Formatter

The basic formatter is a barebones formatter that simply takes the data provided, serializes it with a fork of [gopkg.in/yaml.v3](https://www.github.com/braydonk/yaml) and encodes it again. This provides a consistent output format that is very opinionated with some minor tweak options.
The basic formatter is a barebones formatter that simply takes the data provided, serializes it with a fork of [gopkg.in/yaml.v3][1] and encodes it again. This provides a consistent output format that is very opinionated with some minor tweak options.

### Configuration

Expand All @@ -63,6 +63,7 @@ The basic formatter is a barebones formatter that simply takes the data provided

### Note on `max_line_length`

It's not perfect; it uses the `best_width` setting from the yaml library. If there's a very long token that extends too far for the line width, it won't split it up properly. I will keep trying to make this work better, but decided to get a version of the feature in that works for a lot of scenarios even if not all of them.
It's not perfect; it uses the `best_width` setting from the [gopkg.in/yaml.v3][1] library. If there's a very long token that extends too far for the line width, it won't split it up properly. I will keep trying to make this work better, but decided to get a version of the feature in that works for a lot of scenarios even if not all of them.

[1]: https://www.github.com/braydonk/yaml
[Specifying Paths]: ./paths.md

0 comments on commit 2180c98

Please sign in to comment.