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

Fix markdown lint errors

Browse Source
This commit is contained in:
William Sandner
2023-03-24 17:29:16 +01:00
parent 0d20f4e5b1
commit c504fc26da
50 changed files with 702 additions and 637 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
Glossary.md
View File

@@ -1,4 +1,5 @@
<!-- markdownlint-disable-next-line MD041 -->
<!-- markdownlint-disable-next-line first-line-h1 -->
**Process impact:** This file as a dictionary of terms defined as they
are used during the project. Writing out the definitions of terms and
acronyms here helps keep other documents more concise and precise. A
@@ -13,25 +14,25 @@ Jump to: [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) |
### Project-specific Terms
*TIPs:*
_TIPs:_
- *Define HTML anchors on your terms with id="TERMNAME" so that other
documents can link to the definition of specific terms.*
- *If there is any question about the meaning of a term, note it here.
- _Define HTML anchors on your terms with id="TERMNAME" so that other
documents can link to the definition of specific terms._
- _If there is any question about the meaning of a term, note it here.
If someone (e.g., the customer) gave you a definition to use, note
that here too. If something is best defined by using a hyperlink to
another document or website, include a hyperlink in the definition.*
- *If a term was used in the past, but is no longer going to be used,
another document or website, include a hyperlink in the definition._
- _If a term was used in the past, but is no longer going to be used,
you should keep it in the list, mark it as "deprecated", and link to
the term or terms that replace it. E.g., deprecated standard term
[bug](glossary-std.html#bug).*
- *Define only project-specific terms, or ones that a new team member
[bug](glossary-std.html#bug)._
- _Define only project-specific terms, or ones that a new team member
would not know. Don't define standard textbook terms that can be
easily found elsewhere.*
- *This glossary can serve as simple domain model or data dictionary.
easily found elsewhere._
- _This glossary can serve as simple domain model or data dictionary.
You can define important data objects by describing their meaning
and key attributes. For example, see [student](#student) and
[GPA](#gpa).*
[GPA](#gpa)._
#### A
@@ -47,7 +48,7 @@ Jump to: [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) |
- ::Real-world meaning of values:
| | |
|-------------|---------------------------------|
| ----------- | ------------------------------- |
| ::Freshman | ::Less than 90 units |
| ::Sophomore | ::Between 90 and 180 units |
| ::Junior | ::Between 180 and 270 units |
@@ -59,12 +60,12 @@ Jump to: [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) |
##### ::GEF
::*n.* The [Graph Editing Framework](http://gef.tigris.org/). An open
::_n._ The [Graph Editing Framework](http://gef.tigris.org/). An open
source library for editing diagrams (boxes and arrows).
##### ::GPA
::*n.* Grade Point Average. GPA is a float between 0.00 and 4.00,
::_n._ Grade Point Average. GPA is a float between 0.00 and 4.00,
accurate to 2 decimal places. Computed from average of completed
course grades in transcript weighted by course units. Used to
determine student ranking, and to trigger Dean's List and
@@ -74,22 +75,22 @@ academic probation.
##### ::ICS
::*n.* Acronym for the [School of Information and Computer
::_n._ Acronym for the [School of Information and Computer
Science](http://www.ics.uci.edu/) at [UC Irvine](http://www.uci.edu/).
#### S
##### ::Student
::*n.* A person who attends a school to earn a degree. Persistent
attributes include: student\_id\_number (primary key), GPA, major,
and years\_at\_school.
::_n._ A person who attends a school to earn a degree. Persistent
attributes include: student_id_number (primary key), GPA, major,
and years_at_school.
##### ::Senior
::*n.* A senior is special type of [undergraduate](#undergraduate) who
::_n._ A senior is special type of [undergraduate](#undergraduate) who
has a certain number of course credits on his or her transcript.
Years\_at\_school does not determine senior standing. TODO: how many
Years_at_school does not determine senior standing. TODO: how many
credits needed?
#### T
@@ -111,4 +112,4 @@ credits needed?
##### ::Undergraduate
::A type of [student](#student). *TODO: add more detail.*
::A type of [student](#student). _TODO: add more detail._