erg/doc/EN/dev_guide/doc_guideline.md
2022-08-19 13:35:05 +09:00

11 lines
683 B
Markdown

# format
Any document that does not follow the rules below is subject to correction.
* 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 document is out-of-date, follow [these instructions](https://github.com/erg-lang/erg/issues/48#issuecomment-1218247362) to update it.
---
<span id="1" style="font-size:x-small"><sup>1</sup> See this for how to write footnotes. [](#f1)</span>