Fix markdown lint errors
This commit is contained in:
38
Use-Cases.md
38
Use-Cases.md
@@ -1,4 +1,5 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
<!-- markdownlint-disable-next-line first-line-h1 -->
|
||||
|
||||
##### Project
|
||||
|
||||
::PROJECT-NAME
|
||||
@@ -18,9 +19,9 @@
|
||||
|
||||
---
|
||||
|
||||
*TODO: Note any aspects that are common to all use cases here. This helps
|
||||
_TODO: Note any aspects that are common to all use cases here. This helps
|
||||
keep the use cases themselves short. If any use case is an exception,
|
||||
note it's specific value to replace or add to the default.*
|
||||
note it's specific value to replace or add to the default._
|
||||
|
||||
### Default Aspects of All Use Cases
|
||||
|
||||
@@ -39,17 +40,17 @@ note it's specific value to replace or add to the default.*
|
||||
|
||||
::User is logged in
|
||||
|
||||
*TODO: For each use case listed in the [use case
|
||||
_TODO: For each use case listed in the [use case
|
||||
suite](Use-Case-Suite), create an HTML anchor and heading with it's
|
||||
unique ID, then fill in the rows of the table to specify the use case in
|
||||
detail.*
|
||||
detail._
|
||||
|
||||
*TIP: It is OK to simply list the names of a lot of use cases without
|
||||
_TIP: It is OK to simply list the names of a lot of use cases without
|
||||
actually writing the use case in detail. Document the most important use
|
||||
cases first and come back to less important ones later.*
|
||||
cases first and come back to less important ones later._
|
||||
|
||||
*TIP: See detailed tips in the
|
||||
[guidelines for writing use cases](Use-Case-Format#further-information).*
|
||||
_TIP: See detailed tips in the
|
||||
[guidelines for writing use cases](Use-Case-Format#further-information)._
|
||||
|
||||
---
|
||||
|
||||
@@ -88,7 +89,7 @@ cases first and come back to less important ones later.*
|
||||
|
||||
- ::How will administrators know the right timezone abbreviation?
|
||||
- They would know it if they live in that timezone. Maybe we could
|
||||
provide a drop-down list of all choices, but each would need some explanation.
|
||||
provide a drop-down list of all choices, but each would need some explanation.
|
||||
|
||||
---
|
||||
|
||||
@@ -390,6 +391,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -441,6 +443,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -492,6 +495,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -543,6 +547,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -594,6 +599,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -645,6 +651,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -696,6 +703,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -747,6 +755,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -798,6 +807,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -849,6 +859,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -900,6 +911,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -951,6 +963,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -1002,6 +1015,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -1053,6 +1067,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -1104,6 +1119,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -1155,6 +1171,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
@@ -1206,6 +1223,7 @@ cases first and come back to less important ones later.*
|
||||
**Alternative Scenario Extensions:**
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
||||
- ::NOTES or DETAILS.
|
||||
|
||||
- ::If CONDITION, then ALTERNATIVE STEPS.
|
||||
|
Reference in New Issue
Block a user