RepoMirrors
/
ale
mirror of https://github.com/dense-analysis/ale
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make documentation more consistent with Vim's own :help (#4840) 

* Prefix user-defined commands with colons

This is consistent with Vim's own :help pages.

* Remove dot hack

Now that we have `:ALEInfo` and `ALEInfo`, we don't need `ALEInfo.` any
more to disambiguate them.

* Use colons in references

* Use angle brackets for command arguments

* Use `:Command` for command references

* Use a non-command reference for tsserver

* Prefix highlight references with hl-

* Fix some references into Vim's own :help

E.g. location-list or +features

* Misc hotlink improvements

* Undo previous changes to tsserver

Just leave it in backticks - even though I don't like it.

* Use bars for a command for consistency

* Append hotlinks to hl-groups

Remove minuses to make tables look more like in Vim's own :help

* Prefix features with +

* Provide full hotlink to ale.txt

* Fix double pipe typo

* Capitalize Error highlight

There seems to be no hotlink in Vim's own documentation for this.
I would have expected *hl-Error* - no such thing :-(

* Right align tags to col 79
This commit is contained in:
Friedrich C. Kischkel 2024-10-19 17:18:24 +02:00 committed by GitHub
parent 0b4c665840
commit 02eb9984b1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 196 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/ale-development.txt
View File

@ -49,10 +49,10 @@ changes should be preceded by a deprecation phase complete with warnings.
Changes required for security may be an exception. Changes required for security may be an exception.
ALE supports Vim 8 and above, and NeoVim 0.6.0 or newer. These are the ALE supports Vim 8 and above, and NeoVim 0.6.0 or newer. These are the
earliest versions of Vim and NeoVim which support |job|, |timer|, |closure|, earliest versions of Vim and NeoVim which support |+job|, |+timer|,
and |lambda| features. All ALE code should be written so it is compatible with |+closure|, and |+lambda| features. All ALE code should be written so it is
these versions of Vim, or with version checks so particular features can compatible with these versions of Vim, or with version checks so particular
degrade or fail gracefully. features can degrade or fail gracefully.
Just about everything should be documented and covered with tests. Just about everything should be documented and covered with tests.
@ -486,7 +486,7 @@ last minor version.
Generally ALE releases hit a major version only when there are breaking Generally ALE releases hit a major version only when there are breaking
changes to a public ALE setting or function. A "public" setting or function is changes to a public ALE setting or function. A "public" setting or function is
defined as any setting or function documented in the `:help` |ale| text file. defined as any setting or function documented in the `:help` |ale.txt| file.
Major ALE versions ought to be so rare that they only come once a year at Major ALE versions ought to be so rare that they only come once a year at
most. ALE should not typically introduce any breaking changes. most. ALE should not typically introduce any breaking changes.

375
doc/ale.txt
View File

File diff suppressed because it is too large Load Diff