# format

Any document that does not follow the rules below is subject to correction.

* Write code comments or internal documentation in a certain tone.
* Documents to be shown to the outside (general users) should be written more and more.
* Always include definitions, meanings, or links to terms that appear for the first time in the document.
* Use parentheses as a proviso only for sentences that are supplementary but necessary for understanding the main text, and use footnotes for sentences that are not essential for understanding the main text[<sup id="f1">1</ sup>](#1).
* If the content of the document is outdated, update it according to [this method](https://github.com/erg-lang/erg/issues/48#issuecomment-1218247362).
* Files under `syntax` should have sequential numbers at the beginning of their file names, except for those not included in the document.
  * Scripts that automatically insert and replace files exist in doc/script.

---

<span id="1" style="font-size:x-small"><sup>1</sup> See this for how to write footnotes. [↩](#f1)</span>
