Skip to content

Commit

Permalink
doc: Update cspell-types docs (#2190)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S committed Jan 7, 2022
1 parent 04d6137 commit f68b971
Show file tree
Hide file tree
Showing 36 changed files with 619 additions and 407 deletions.
30 changes: 15 additions & 15 deletions docs/types/cspell-types/interfaces/BaseSetting.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ True to enable compound word checking.

#### Defined in

[CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L308)
[CSpellSettingsDef.ts:347](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L347)

___

Expand All @@ -60,7 +60,7 @@ Determines if words must match case and accent rules.

#### Defined in

[CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L319)
[CSpellSettingsDef.ts:358](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L358)

___

Expand All @@ -72,7 +72,7 @@ Optional description of configuration.

#### Defined in

[CSpellSettingsDef.ts:287](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L287)
[CSpellSettingsDef.ts:326](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L326)

___

Expand All @@ -87,7 +87,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`.

#### Defined in

[CSpellSettingsDef.ts:330](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L330)
[CSpellSettingsDef.ts:369](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L369)

___

Expand All @@ -99,7 +99,7 @@ Define additional available dictionaries.

#### Defined in

[CSpellSettingsDef.ts:322](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L322)
[CSpellSettingsDef.ts:361](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L361)

___

Expand All @@ -113,7 +113,7 @@ Is the spell checker enabled.

#### Defined in

[CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L293)
[CSpellSettingsDef.ts:332](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L332)

___

Expand All @@ -125,7 +125,7 @@ List of words to always be considered incorrect.

#### Defined in

[CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L299)
[CSpellSettingsDef.ts:338](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L338)

___

Expand All @@ -137,7 +137,7 @@ Optional identifier.

#### Defined in

[CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L281)
[CSpellSettingsDef.ts:320](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L320)

___

Expand All @@ -151,7 +151,7 @@ Example: ["href"] - to exclude html href.

#### Defined in

[CSpellSettingsDef.ts:348](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L348)
[CSpellSettingsDef.ts:387](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L387)

___

Expand All @@ -163,7 +163,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i

#### Defined in

[CSpellSettingsDef.ts:302](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L302)
[CSpellSettingsDef.ts:341](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L341)

___

Expand All @@ -176,7 +176,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will

#### Defined in

[CSpellSettingsDef.ts:354](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L354)
[CSpellSettingsDef.ts:393](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L393)

___

Expand All @@ -188,7 +188,7 @@ Optional name of configuration.

#### Defined in

[CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L284)
[CSpellSettingsDef.ts:323](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L323)

___

Expand All @@ -206,7 +206,7 @@ possible suggestions.

#### Defined in

[CSpellSettingsDef.ts:341](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L341)
[CSpellSettingsDef.ts:380](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L380)

___

Expand All @@ -218,7 +218,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx

#### Defined in

[CSpellSettingsDef.ts:357](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L357)
[CSpellSettingsDef.ts:396](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L396)

___

Expand All @@ -230,4 +230,4 @@ List of words to be always considered correct.

#### Defined in

[CSpellSettingsDef.ts:296](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellSettingsDef.ts#L296)
[CSpellSettingsDef.ts:335](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellSettingsDef.ts#L335)
12 changes: 6 additions & 6 deletions docs/types/cspell-types/interfaces/CSpellReporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

#### Defined in

[CSpellReporter.ts:63](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellReporter.ts#L63)
[CSpellReporter.ts:69](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellReporter.ts#L69)

___

Expand All @@ -31,7 +31,7 @@ ___

#### Defined in

[CSpellReporter.ts:64](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellReporter.ts#L64)
[CSpellReporter.ts:70](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellReporter.ts#L70)

___

Expand All @@ -41,7 +41,7 @@ ___

#### Defined in

[CSpellReporter.ts:62](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellReporter.ts#L62)
[CSpellReporter.ts:68](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellReporter.ts#L68)

___

Expand All @@ -51,7 +51,7 @@ ___

#### Defined in

[CSpellReporter.ts:61](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellReporter.ts#L61)
[CSpellReporter.ts:67](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellReporter.ts#L67)

___

Expand All @@ -61,7 +61,7 @@ ___

#### Defined in

[CSpellReporter.ts:65](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellReporter.ts#L65)
[CSpellReporter.ts:71](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellReporter.ts#L71)

___

Expand All @@ -71,4 +71,4 @@ ___

#### Defined in

[CSpellReporter.ts:66](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellReporter.ts#L66)
[CSpellReporter.ts:72](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellReporter.ts#L72)
2 changes: 1 addition & 1 deletion docs/types/cspell-types/interfaces/CSpellReporterModule.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@

#### Defined in

[CSpellReporter.ts:70](https://github.com/streetsidesoftware/cspell/blob/8c8dfb70/packages/cspell-types/src/CSpellReporter.ts#L70)
[CSpellReporter.ts:76](https://github.com/streetsidesoftware/cspell/blob/04d61378/packages/cspell-types/src/CSpellReporter.ts#L76)
Loading

0 comments on commit f68b971

Please sign in to comment.