emelie/tidy-html5
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Some tweaks to CODESTYLE.md

Browse source
This commit is contained in:
Geoff McLane 2015-09-04 16:16:24 +02:00
parent 156cab70b8
commit dc3fbe28b7
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CODESTYLE.md
View file

@ -1,10 +1,10 @@
# HTML Tidy Code Style # HTML Tidy Code Style
The source code of **libTidy**, and console Tidy, follow the preferences of the original maintainers. Perhaps some of these decisions were arbitrary and based on their sense of aesthetics but it is good to have all the code look the same even if it is not exactly how everyone would prefer. The source code of **libTidy**, and console app **tidy**, follow the preferences of the original maintainers. Perhaps some of these decisions were arbitrary and based on their sense of aesthetics at the time, but it is good to have all the code looking the same even if it is not exactly what everyone would prefer.
Developers adding code to Tidy! are urged to try to follow the existing code style. Code that does not follow these conventions will be accepted, but will be modified as time goes by to best fit the `Tidy Style`. Developers adding code to **Tidy!** are urged to try to follow the existing code style. Code that does not follow these conventions may be accepted, but may be modified as time goes by to best fit the `Tidy Style`.
There has been a suggestion of using available utilities to make the style consistent, like [Uncrusty](https://github/bengardener/uncrusty)... There has been a suggestion of using available utilities to make the style consistent, like [Uncrusty](https://github/bengardener/uncrusty) - see issue #245 and maybe others...
Others have suggested the [AStyle](http://astyle.sourceforge.net/) formatting program with say '-taOHUKk3 -M8' arguments, to conform, but there are a few bugs in AStyle. Others have suggested the [AStyle](http://astyle.sourceforge.net/) formatting program with say '-taOHUKk3 -M8' arguments, to conform, but there are a few bugs in AStyle.