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

correct speliling in CODESTYLE.md

Browse source
This commit is contained in:
Geoff McLane 2015-09-04 15:52:12 +02:00
parent 05cf142e07
commit e4c8c6c489
1 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CODESTYLE.md
View file

@ -1,14 +1,14 @@
# 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 its not exactly how everyone would prefer. 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.
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 will be accepted, but will 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)...
Others have suggested the [AStyle](http://astyle.sourceforge.net/) formatting program with '-taOHUKk3 -M8' arguments formats code in much the right way although 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.
But again these, and other tools may not produce code that everybody agrees with... and are presently not formally used in Tidy! But again these, and other tools, may not produce code that everybody agrees with... and are presently not formally used in Tidy!
#### Known Conventions #### Known Conventions
@ -19,7 +19,6 @@ From reading of the Tidy source, some things are self evident... in no particula
- The openning `{` is indented on the next newline. - The openning `{` is indented on the next newline.
- While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines. - While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines.
Look forward to this document being filled out in detail... Look forward to this document being filled out in detail...
Date: 20150904 Date: 20150904