fix: Make updating subsection an optional suggestion, and describe it
Closes #65
This commit is contained in:
parent
8e271642f9
commit
d05361bb82
2
spec.md
2
spec.md
@ -136,12 +136,12 @@ progressively greater amount of knowledge."
|
|||||||
|
|
||||||
**Subsections:**
|
**Subsections:**
|
||||||
- `Dependencies`. Required if there are unusual dependencies or dependencies that must be manually installed.
|
- `Dependencies`. Required if there are unusual dependencies or dependencies that must be manually installed.
|
||||||
- `Updating`. Optional.
|
|
||||||
|
|
||||||
**Suggestions:**
|
**Suggestions:**
|
||||||
- Link to prerequisite sites for programming language: [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc.
|
- Link to prerequisite sites for programming language: [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc.
|
||||||
- Include any system-specific information needed for installation.
|
- Include any system-specific information needed for installation.
|
||||||
- If there is no code in the module - for instance, a document-based module - this section is not required.
|
- If there is no code in the module - for instance, a document-based module - this section is not required.
|
||||||
|
- An `Updating` section would be useful for most packages, if there are multiple versions which the user may interface with.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
**Status:** Required by default, optional for doc modules.
|
**Status:** Required by default, optional for doc modules.
|
||||||
|
Loading…
Reference in New Issue
Block a user