mirror of
https://github.com/erg-lang/erg.git
synced 2025-10-02 13:41:10 +00:00
13 lines
1.2 KiB
Markdown
13 lines
1.2 KiB
Markdown
# format
|
|
|
|
[](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=doc/EN/dev_guide/doc_guideline.md&commit_hash=3b9be7ad98476f68859ef0deeb5adb24f4155068)
|
|
|
|
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>
|