From 2180c9818f4131c6eab0810bab30e87c2d5b1834 Mon Sep 17 00:00:00 2001 From: James Braza Date: Mon, 2 Oct 2023 12:49:48 -0700 Subject: [PATCH] Linking yaml v2 library in docs --- docs/config-file.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/config-file.md b/docs/config-file.md index 42a71a8..c5acd77 100644 --- a/docs/config-file.md +++ b/docs/config-file.md @@ -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 @@ -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