hawkinsw/gp4
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation: Describe NOTEs

Browse Source 
Describe how/why notes are used in the code.

Signed-off-by: Will Hawkins <hawkinsw@obs.cr>
This commit is contained in:
Will Hawkins
2026-04-20 05:59:27 -04:00
parent 78a53d388f
commit 5a9ef6ce4d
2 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15
View File
@@ -87,6 +87,21 @@ where `<component>` is one of:
where `<subcomponent>` can be more free-form and `<change>` is a pithy description of the changes in the commit.
#### Notes To Self
While coding, it may be useful to leave ourselves notes. Every note is formatted like:
```Swift
/// NOTE: note text
```
where `NOTE` can be:
1. `TODO`: Remind us `TODO` something.
2. `ASSUME`: Remind us that we are making an assumption.
3. `NB`: Remind us that we need to remember something when reading this code.
#### Testing
To run the P4RSE tests: