Suborbital-Systems/ReadySetGit
2
0
Fork 0
Code Pull Requests Packages Projects Releases Activity

Fix linter issues

Browse Source
This commit is contained in:
William Sandner 2023-03-25 12:32:32 +01:00
parent 3bcd105246
commit 242ffe9d55
3 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Feature-Format.md
View File

@ -1,5 +1,4 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)

24
Glossary-Standard-Terms.md
View File

@ -6,7 +6,7 @@ helps keep other documents more concise and easy to edit. Check the
[ReadySET glossary](https://web.archive.org/web/20200702035436/http://readyset.tigris.org/templates/glossary-std.html) for [ReadySET glossary](https://web.archive.org/web/20200702035436/http://readyset.tigris.org/templates/glossary-std.html) for
updates. updates.
Jump to: [General](#general-terms) | [Computer science & technology](#computer-science-and-technology-terms) | [Process](#process-terms) | [Software development tools](#development-tool-terms) | [Requirements](#requirements-terms) | [Design](#design-terms) | [Design goals terms](#desigD-DIAGRAMn-goals-terms) | [QA terms](#qa-terms) | [QA goals terms](#qa-goals-terms) | [Additional terms](#additional-standard-terms)| [Project terms](Glossary) Jump to: [General](#general-terms) | [Computer science & technology](#computer-science-and-technology-terms) | [Process](#process-terms) | [Software development tools](#development-tool-terms) | [Requirements](#requirements-terms) | [Design](#design-terms) | [Design goals terms](#design-goals-terms) | [QA terms](#qa-terms) | [QA goals terms](#qa-goals-terms) | [Additional terms](#additional-standard-terms)| [Project terms](Glossary)
## General Terms ## General Terms
@ -138,7 +138,7 @@ than "10.1" or "11".
### Release Number ### Release Number
The term "release number" by itself refers to an The term "release number" by itself refers to an
[external release number](#external_release_number). Users normally are not aware [external release number](#external-release-number). Users normally are not aware
of the existence of any internal release numbers. of the existence of any internal release numbers.
## Development Tool Terms ## Development Tool Terms
@ -322,18 +322,18 @@ this system.
### Bug ### Bug
_n._ **Deprecated** since 1991. See [defect](#defect). *n.* **Deprecated** since 1991. See [defect](#defect).
### Error ### Error
_v._ A mistaken thought in the developer's mind. Often caused by *v.* A mistaken thought in the developer's mind. Often caused by
miscommunication or bad assumptions. Errors can create miscommunication or bad assumptions. Errors can create
[defects](#defect). E.g., a developer might erroneously think that [defects](#defect). E.g., a developer might erroneously think that
the square root of -4 is -2. the square root of -4 is -2.
### Defect ### Defect
_n._ The result of the developer's [error](#error) embodied in the *n.* The result of the developer's [error](#error) embodied in the
product source code, initial data, or documents. E.g., a square root product source code, initial data, or documents. E.g., a square root
function which allows negative numbers as arguments is defective. function which allows negative numbers as arguments is defective.
Defects can be removed by changing the source code, initial data, Defects can be removed by changing the source code, initial data,
@ -341,7 +341,7 @@ or document.
### Fault ### Fault
_n._ The execution of defective code. E.g., if a certain input is *n.* The execution of defective code. E.g., if a certain input is
provided to defective code, it may cause an exception, or go into an provided to defective code, it may cause an exception, or go into an
infinite loop, or store an incorrect value in an internal variable. infinite loop, or store an incorrect value in an internal variable.
A fault is not normally visible to users, only the A fault is not normally visible to users, only the
@ -349,7 +349,7 @@ A fault is not normally visible to users, only the
### Failure ### Failure
_n._ The user-visible result of a [fault](#fault). E.g., an error *n.* The user-visible result of a [fault](#fault). E.g., an error
message or an incorrect result. This is evidence that can be message or an incorrect result. This is evidence that can be
reported in a defect report. Developers use failure evidence during reported in a defect report. Developers use failure evidence during
debugging to eventually find and remove [defects](#defect). debugging to eventually find and remove [defects](#defect).
@ -386,10 +386,10 @@ this document.
Is the data in the system a true representation of the real world? Is the data in the system a true representation of the real world?
Any system that contains initial data or gathers data about the real Any system that contains initial data or gathers data about the real
D-DIAGRAM world should be sure that the data is factually correct. E.g., a tax
D-DIAGRAM preparation program should embody correct and up-to-date facts about
D-DIAGRAM tax law.
D-DIAGRAM
#### Usability > Understandability and Readability #### Usability > Understandability and Readability
Users need to understand the system to use it. The basic metaphor Users need to understand the system to use it. The basic metaphor
@ -534,6 +534,6 @@ For additional standard terms, see the following reference sites:
- [Dictionary.com](http://www.dictionary.com/) - [Dictionary.com](http://www.dictionary.com/)
- [Whatis.com](http://www.whatis.com/) - [Whatis.com](http://www.whatis.com/)
- [NIST Dictionary of Algorithms and Data Structures](http://www.nist.gov/dads/) - [NIST Dictionary of Algorithms and Data Structures](http://www.nist.gov/dads/)
- [Free on-line dictionary of computing](http:/http://foldoc.doc.ic.ac.uk/foldoc/index.html) - [Free on-line dictionary of computing](http://foldoc.doc.ic.ac.uk/foldoc/index.html)
- [IBM's glossary of computing terms](http://www-3.ibm.com/ibm/terminology/goc/gocmain.htm) - [IBM's glossary of computing terms](http://www-3.ibm.com/ibm/terminology/goc/gocmain.htm)
- [Jargon File](http://www.jargon.org/) - [Jargon File](http://www.jargon.org/)

4
Use-Case-Format.md
View File

@ -31,9 +31,9 @@ file.*
**Prerequisite:** **Prerequisite:**
::Project is set up ::Project is set up
_TODO: Copy and paste this use case template as many times as needed in *TODO: Copy and paste this use case template as many times as needed in
your [Use Cases](Use-Cases) document. Only use those fields that your [Use Cases](Use-Cases) document. Only use those fields that
are not the same as the default for all use cases._ are not the same as the default for all use cases.*
--- ---