adelorenzo/kilo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: use consistent notes

Browse Source 
This commit standardizes how we display a `note` in our docs.
Previously, we used a mix of `_Note_:`, `__Note:__`, `> Note`, and `>
**Note**:` among others. Now, all notes appear as `> **Note**:`.

Signed-off-by: Lucas Servén Marín <lserven@gmail.com>
This commit is contained in:
Lucas Servén Marín
2021-07-08 12:15:17 +02:00
parent 6b5001bf0e
commit 7756b5ce04
6 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/docs-gen/main.go
View File

@@ -32,7 +32,7 @@ const (
firstParagraph = `# API
This document is a reference of the API types introduced by Kilo.
> Note this document is generated from code comments. When contributing a change to this document, please do so by changing the code comments.`
> **Note**: this document is generated from code comments. When contributing a change to this document, please do so by changing the code comments.`
)
var (