Skip to content

Commit

Permalink
chore: doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
moshloop committed May 27, 2024
1 parent df4d295 commit b5a9c74
Show file tree
Hide file tree
Showing 9 changed files with 303 additions and 311 deletions.
8 changes: 4 additions & 4 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Vocab = Technical

Packages = Google, alex, Readability

[*.md]
BasedOnStyles = Vale, Flanksource, alex, Readability
[formats]
mdx = md

[*.mdx]
BasedOnStyles = Vale, Flanksource, alex, Readability
[*.md]
BasedOnStyles = Vale, Flanksource, alex
4 changes: 2 additions & 2 deletions canary-checker/docs/scripting/cel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2028,8 +2028,8 @@ length.
### .trim
Returns a new string which removes the leading and trailing whitespace in the
target string. The trim function uses the Unicode definition of whitespace
Returns a new string which removes the leading and trailing space.
The trim function uses the Unicode definition of space.
which does not include the zero-width spaces.
```javascript
Expand Down
7 changes: 3 additions & 4 deletions canary-checker/docs/scripting/gotemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,7 @@ A wrapper for Go's [`path.Split`](https://golang.org/pkg/path/#Split) function.

### ASCII

Generates a random string of a desired length, containing the set of printable characters from the 7-bit [ASCII](https://en.wikipedia.org/wiki/ASCII) set. This includes _space_ (' '), but no other whitespace characters.
Generates a random string of a desired length, containing the set of printable characters from the 7-bit [ASCII](https://en.wikipedia.org/wiki/ASCII) set. This includes _space_ (' '), but no other space characters.

```go
{{ random.ASCII 8 }} // _woJ%D&K
Expand Down Expand Up @@ -1509,8 +1509,7 @@ This wraps Go's [`strings.TrimPrefix`](https://golang.org/pkg/strings/#TrimPrefi

### TrimSpace

Trims a string by removing whitespace from the beginning and end of
the string.
Trims a string by removing space from the beginning and end.

```go
{{ " \n\t foo" | strings.TrimSpace }} // foo
Expand Down Expand Up @@ -1575,7 +1574,7 @@ See [Kebab Case on Wikipedia](https://en.wikipedia.org/wiki/Kebab_case) for more

### WordWrap

Inserts new line breaks into the input string so it ends up with lines that are at most `width` characters wide. The line-breaking algorithm is _naïve_ and _greedy_: lines are only broken between words (i.e. on whitespace characters), and no effort is made to "smooth" the line endings. When words that are longer than the desired width are encountered (e.g. long URLs), they are not broken up. Correctness is valued above line length.
Inserts new line breaks into the input string so it ends up with lines that are at most `width` characters wide. The line-breaking algorithm is _naïve_ and _greedy_: lines are only broken between words (i.e. on space characters), and no effort is made to "smooth" the line endings. When words that are longer than the desired width are encountered (e.g. long URLs), they are not broken up. Correctness is valued above line length.

The line-break sequence defaults to `\n` (i.e. the LF/Line Feed character), regardless of OS.

Expand Down
9 changes: 0 additions & 9 deletions styles/Flanksource/DateFormat.yml

This file was deleted.

23 changes: 0 additions & 23 deletions styles/Flanksource/DigitalOceanTerms.yml

This file was deleted.

1 change: 0 additions & 1 deletion styles/Flanksource/Foreign.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ nonword: true
action:
name: replace
swap:
'\b(?:eg|e\.g\.)[\s,]': for example
'\b(?:ie|i\.e\.)[\s,]': that is
'\b(?:viz\.)[\s,]': namely
'\b(?:ergo)[\s,]': therefore
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit b5a9c74

Please sign in to comment.