github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-23 01:36:39 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update FORMATTING.md (#5087)

Browse Source
This commit is contained in:
gkdoc 2018-07-09 20:54:56 -07:00 committed by ridiculousfish
parent 28455235b1
commit c04cb9c715
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc_src/FORMATTING.md
View File

@ -8,7 +8,7 @@ While the documentation is pretty robust to variations in the documentation sour
## Line breaks and wrapping
Contrary to the rest of the fish source code, the documentation greatly benefits from the use of long lines and soft wrapping. It allows paragraphs to be treated as complete blocks by Doxygen, means that the semantic filter can see complete lines when deciding on how to apply syntax highlighting, and means that man pages will consistently wrap to the width of the users console in advanced pagers, such as 'most'.
Contrary to the rest of the fish source code, the documentation greatly benefits from the use of long lines and soft wrapping. Doxygen is able to treat paragraphs as complete blocks. The semantic filter can see complete lines when deciding on how to apply syntax highlighting. In advanced pagers, such as 'most', man pages will consistenly wrap to the width of the user's console.
## Doxygen special commands and aliases