Fix linter warnings

2021-08-01 15:15:57 +02:00 · 2021-08-01 15:15:57 +02:00 · 704e13c18f
commit 704e13c18f
parent 70a43d171f
30 changed files with 135 additions and 106 deletions
--- a/Installation-Guide.md
+++ b/Installation-Guide.md
@ -1,24 +1,25 @@
 <!-- markdownlint-disable-next-line MD041 -->
 *TODO: Fill in information about this product. Make sure to use the
 **product** name and **external** release number, not internal
 information.*
-##### Product:
+##### Product
 ::PRODUCT-NAME
-##### Release Number:
+##### Internal Release Number
 ::X.Y.Z
-##### Release Date:
+##### Release Date
 ::YEAR/MONTH/DAY
-##### Customer Support:
+##### Customer Support
 :: For more information or support, please visit our
-[website](http://www.COMPANY.com/products/PRODUCT-NAME/) or 
+[website](::http://www.COMPANY.com/products/PRODUCT-NAME/) or
-email us at <support@COMPANY.com>
+email us at <::support@COMPANY.com>
 ---
--- a/Interview-Checklist.md
+++ b/Interview-Checklist.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Related Documents
 - [User Needs](User-Needs)
--- a/Interview-Notes.md
+++ b/Interview-Notes.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
--- a/Legal.md
+++ b/Legal.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
@ -6,14 +7,14 @@
 ::X.Y.Z
-##### Release Audience:
+##### Release Audience
 - ::General availability release ||
 - ::Customer-specific release: CUSTOMER(S) ||
 - ::Developer release (Internal usage only) ||
 - ::Early access release (Controlled external access)
-##### Intended Product License:
+##### Intended Product License
 ::Commercial license
--- a/License.md
+++ b/License.md
@ -1,4 +1,4 @@
-
+<!-- markdownlint-disable-next-line MD041 -->
 Do not modify or delete this file. This file describes the license under
 which you may use the ReadySET templates.
--- a/Project-Plan.md
+++ b/Project-Plan.md
@ -1,12 +1,13 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
-##### Project Time-frame:
+##### Project Time-frame
 ::START-DATE - END-DATE
-##### Attached worksheets:
+##### Attached worksheets
 - Plan > [Resource Needs](Resource-Needs)
--- a/Proposal.md
+++ b/Proposal.md
@ -1,16 +1,17 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
-##### Project Time-frame:
+##### Project Time-frame
 ::2003/1/16 to 2003/3/19
-##### Summary:
+##### Summary
 ::2-4 SENTENCE SUMMARY
-##### Attached Worksheets:
+##### Attached Worksheets
 Project Proposal > [Target audience and benefits](Target-and-Benefits)
@ -63,8 +64,8 @@ motivated or honest in their evaluations. There are already some
 clan directory web sites, but they are not automated so they are
 always out of date and do not rate the quality of the websites.
- ::[Example of current manually maintained clan website](#)
+- ::[Example of current manually maintained clan website](#tbd)
- ::[Link to existing competitor](#)
+- ::[Link to existing competitor](#tbd)
 #### Why is this problem worth solving or worth solving better?
@ -99,9 +100,9 @@ those advantages.
 ::The following pages provide additional background and motivation:
- ::[Magazine article on this topic](#)
+- ::[Magazine article on this topic](#tbd)
- ::[Industry analysis's report on massive-multi-player game market](#)
+- ::[Industry analysis's report on massive-multi-player game market](#tbd)
- ::[Quotes from game players](#)
+- ::[Quotes from game players](#tbd)
 ### Goal
--- a/QA-Plan.md
+++ b/QA-Plan.md
@ -1,3 +1,6 @@
 <!-- markdownlint-disable MD033 -->
 <!-- markdownlint-disable-next-line MD041 -->
 *TODO: For each release, update this file by filling in answers to the
 questions. In cases where multiple answers are already written, delete
 those answers that do not apply.*
@ -6,18 +9,18 @@ those answers that do not apply.*
 ::[PROJECT-NAME](Home)
-##### Internal Release Number:
+##### Internal Release Number
 ::X.Y.Z
-##### Release Audience:
+##### Release Audience
 - ::General availability release ||
 - ::Customer-specific release: CUSTOMER(S) ||
 - ::Developer release (Internal usage only) ||
 - ::Early access release (Controlled external access)
-##### Attached Worksheets:
+##### Attached Worksheets
 - QA plan > [Review meeting notes](Review-Meeting-Notes)
 - QA plan > [System test case suite](Test-Suite)
@ -141,7 +144,7 @@ achieve. If you do not plan to perform an activity, write "N/A".*
 |--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | ::Preconditions                      | <ul><li>::Every public method</li><li>::Every public method in COMPONENT-NAME</li><li>::All public methods that modify data</li></ul>           | ::We will use if-statements at the beginning of public methods to validate each argument value. This helps to document assumptions and catch invalid values before they can cause faults.                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | ::Assertions                         | <ul><li>::Every private method</li><li>::Every private method in COMPONENT-NAME</li><li>::All private methods that modify data</li></ul>        | ::Assertions will be used to validate all arguments to private methods. Since these methods are only called from our other methods, arguments passed to them should always be valid, unless our code is defective. Assertions will also be used to test class invariants and some postconditions.                                                                                                                                                                                                                                                                                                                                                            |
-| ::Static analysis                    | <ul><li>::Strict compiler warnings</li><li>::Automated style checking</li><li>::XML validation</li><li>Detetect common errors</li></ul>         | ::We will use source code analysis tools to automatically detect errors. Style checkers will help make all of our code consistent with our coding standards. XML validation ensures that each XML document conforms to its DTD. Lint-like tools help detect common programming errors. E.g.: [lint](http://www.freebsd.org/cgi/man.cgi?query=lint), [lclint/splint](http://www.splint.org/), [jlint](http://artho.com/jlint/), [checkstyle](http://sourceforge.net/projects/checkstyle/), [Jcsc](http://sourceforge.net/projects/jcsc), [PyLint](https://www.pylint.org/), [PyChecker](http://pychecker.sourceforge.net/), [Tidy](http://www.html-tidy.org/) |
+| ::Static analysis                    | <ul><li>::Strict compiler warnings</li><li>::Automated style checking</li><li>::XML validation</li><li>Detect common errors</li></ul>         | ::We will use source code analysis tools to automatically detect errors. Style checkers will help make all of our code consistent with our coding standards. XML validation ensures that each XML document conforms to its DTD. Lint-like tools help detect common programming errors. E.g.: [lint](http://www.freebsd.org/cgi/man.cgi?query=lint), [lclint/splint](http://www.splint.org/), [jlint](http://artho.com/jlint/), [checkstyle](http://sourceforge.net/projects/checkstyle/), [Jcsc](http://sourceforge.net/projects/jcsc), [PyLint](https://www.pylint.org/), [PyChecker](http://pychecker.sourceforge.net/), [Tidy](http://www.html-tidy.org/) |
 | ::Buddy review                       | <ul><li>::All changes to release branches</li><li>::All changes to COMPONENT-NAME</li><li>::All changes</li></ul>                               | ::Whenever changes must be made to code on a release branch (e.g., to prepare a maintenance release) the change will be reviewed by another developer before it is committed. The goal is to make sure that fixes do not introduce new defects.                                                                                                                                                                                                                                                                                                                                                                                                              |
 | ::Review meetings                    | <ul><li>::Weekly</li><li>::Once before release</li><li>::Every source file</li></ul>                                                            | ::We will hold review meetings where developers will perform formal inspections of selected code or documents. We choose to spend a small, predetermined amount of time and try to maximize the results by selecting review documents carefully. In the review process we will use and maintain a variety of checklists.                                                                                                                                                                                                                                                                                                                                     |
 | ::Unit testing                       | <ul><li>::100% of public methods, and 75% of statements</li><li>::100% of public methods</li><li>::75% of statements</li></ul>                  | ::We will develop and maintain a unit test suite using the JUnit framework. We will consider the boundary conditions for each argument and test both sides of each boundary. Tests must be run and passed before each commit, and they will also be run by the testing team. Each public method will have at least one test. And, the overall test suite will exercise at least 75% of all executable statements in the system.                                                                                                                                                                                                                              |
--- a/Release-Checklist.md
+++ b/Release-Checklist.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 *TODO: For each release, copy this file and fill in answers to the
 questions. In cases where multiple answers are already written, delete
 those answers that do not apply.*
--- a/Release-Notes.md
+++ b/Release-Notes.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 *TODO: For each release, copy this file and fill in the needed
 information.*
@ -149,13 +150,13 @@ prior to generating the report, if you notice that they are incorrect.
 You may exclude or summarize changes that might give away valuable
 proprietary information.*
- ::FIX [09823](#) Screen frozen when caps-lock is on
+- ::FIX [09823](#tbd) Screen frozen when caps-lock is on
- ::FIX [09912](#) Static heard while downloading
+- ::FIX [09912](#tbd) Static heard while downloading
- ::FIX [10923](#) Repeat-mode cannot play more than 99 times
+- ::FIX [10923](#tbd) Repeat-mode cannot play more than 99 times
- ::ENHANCEMENT [08237](#) Scratch DJ-mode
+- ::ENHANCEMENT [08237](#tbd) Scratch DJ-mode
- ::ENHANCEMENT [08238](#) Chill DJ-mode
+- ::ENHANCEMENT [08238](#tbd) Chill DJ-mode
- ::ENHANCEMENT [08259](#) Retro stereo-mode
+- ::ENHANCEMENT [08259](#tbd) Retro stereo-mode
- ::ENHANCEMENT [10202](#) Techno-mode
+- ::ENHANCEMENT [10202](#tbd) Techno-mode
 ### Known Problems and Workarounds
@ -164,11 +165,11 @@ defects discovered in this release, or in previous releases that are
 still not resolved. Include information on workarounds from the issues.
 Otherwise, same as above.*
- ::DEFECT [07293](#) Player skips on very loud playback.
+- ::DEFECT [07293](#tbd) Player skips on very loud playback.
  - ::WORKAROUND: Limit volume to settings 1 through 9.
- ::DEFECT [10509](#) Cannot switch directly from random play mode to
+- ::DEFECT [10509](#tbd) Cannot switch directly from random play mode to
    Internet play-list.
-  - ::WORKAROUND: Switch to local play-list first. Click [here](#) for
+  - ::WORKAROUND: Switch to local play-list first. Click [here](#tbd) for
      detailed instructions.
- ::DEFECT [10589](#) Static heard while booting
+- ::DEFECT [10589](#tbd) Static heard while booting
- ::DEFECT [10944](#) Repeat-mode cannot play more than 999 times
+- ::DEFECT [10944](#tbd) Repeat-mode cannot play more than 999 times
--- a/Resource-Needs.md
+++ b/Resource-Needs.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
@ -6,7 +7,7 @@
 ::X.Y.Z
-##### Project Time-frame:
+##### Project Time-frame
 ::START-DATE - END-DATE
--- a/Review-Meeting-Notes.md
+++ b/Review-Meeting-Notes.md
@ -1,3 +1,5 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
@ -30,8 +32,8 @@
 ### Documents and Code Reviewed at this Meeting
- ::[Feature list section of requirements](#)
+- ::[Feature list section of requirements](#tbd)
- ::[Multi-user section of requirements](#)
+- ::[Multi-user section of requirements](#tbd)
 - ::[Hello.java](/source/browse/PROJECT-NAME/src/Hello.java)
 - ::[HelloStream.java](/source/browse/PROJECT-NAME/src/HelloStream.java)
 - ::[HelloPanel.java](/source/browse/PROJECT-NAME/src/HelloPanel.java)
--- a/Risks.md
+++ b/Risks.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
@ -11,7 +12,7 @@
 - [Project plan](Project-Plan)
 - [Software development methodology](SDM)
-##### References:
+##### References
 - [Risk Management during Requirements](http://www.systemsguild.com/pdfs/s5req.lo%201.pdf) by Tom DeMarco and Tim Lister
 - [Taxonomy-Based Risk Identification](http://www.sei.cmu.edu/pub/documents/93.reports/pdf/tr06.93.pdf) by Carr, Konda, Monarch, Ulrich, and Walker (SEI)
@ -55,7 +56,7 @@ take away our lessons learned and any valuable project bi-products.
 pretend everything is fine and hope that none of the
 stakeholders notice.
-#### Risks that consume development resources.
+#### Risks that consume development resources
 ::The project has a fixed deadline. The requirements are prioritized.
 If we lose time, we will reduce project scope.
--- a/SDM.md
+++ b/SDM.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 *TODO: This template is not done yet. Feel free to contribute your ideas.*
 A Software Development Methodology is always specific to a given
--- a/SRS.md
+++ b/SRS.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::PROJECT-NAME
@ -6,7 +7,7 @@
 ::X.Y.Z
-##### Attached worksheets:
+##### Attached worksheets
 - SRS > [Use case suite](Use-Case-Suite)
 - SRS > [Feature set](Feature-Set)
--- a/Status-Report.md
+++ b/Status-Report.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 *TODO: Copy this file for each status report. Fill in the information
 below. Email a notification to stakeholders when this report is made
 available.*
@ -25,29 +26,29 @@ examples are given, you should select/edit only one.*
 - ::Change Since Last Report: Slipped 2 days
 - ::Change Since Last Report: Saved 4 days
-##### Open Issues (needing development):
+##### Open Issues (needing development)
 - ::[17 defects](ISSUE-TRACKER-QUERY)
- ::[8 enhancements](#)
+- ::[8 enhancements](#tbd)
-##### Resolved Issues (pending verification):
+##### Resolved Issues (pending verification)
- ::[0 defects](#)
+- ::[0 defects](#tbd)
- ::[2 enhancements](#)
+- ::[2 enhancements](#tbd)
-##### Closed Issues:
+##### Closed Issues
- ::[34 defects](#)
+- ::[34 defects](#tbd)
- ::[3 enhancements](#)
+- ::[3 enhancements](#tbd)
-##### Resources used this period:
+##### Resources used this period
 - ::PERSON-NAME: 18 hours.
 - ::PERSON-NAME: 15 hours.
 - ::PERSON-NAME: 10 hours.
 - ::PERSON-NAME: 12 hours.
-##### Status Summary:
+##### Status Summary
 - ::Project completed. This is the final status report.
 - ::Low risk. Project on track.
--- a/Summary.md
+++ b/Summary.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ### Mission and Scope
 *TODO: Answer these questions in your own words. This is condensed
@ -207,18 +208,18 @@ Where is the user documentation?
 the team would not already know them. This is condensed from the
 [glossary](Glossary) documents.*
-##### ::TECHNICAL TERM 1
+#### ::TECHNICAL TERM 1
 ::DEFINITION
-##### ::TECHNICAL TERM 2
+#### ::TECHNICAL TERM 2
 ::DEFINITION
-##### ::TECHNICAL TERM 3
+#### ::TECHNICAL TERM 3
 ::DEFINITION
-##### ::TECHNICAL TERM 4
+#### ::TECHNICAL TERM 4
 ::DEFINITION
--- a/Target-and-Benefits.md
+++ b/Target-and-Benefits.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
@ -33,7 +34,7 @@ examples. Delete them and answer in your own words.*
 ::Open source development tools for SQL database design.
-#### What is the target market for this product? Include specific defining characteristics.
+#### What is the target market for this product? Include specific defining characteristics?
 ::Experienced console game players age 13-35 who enjoy first-person
 shooter games with detailed character animation models and
@ -43,22 +44,22 @@ cinematic segments.
 games, and other content to high-end phones and who are concerned
 about the potential for viruses.
-#### What is the size of the total available market? Cite references for facts.
+#### What is the size of the total available market? Cite references for facts?
-::10,000 users \[[magazine article](#)\].
+::10,000 users \[[magazine article](#tbd)\].
-::$10M, growing annually at 4% \[[industry analyst](#)\].
+::$10M, growing annually at 4% \[[industry analyst](#tbd)\].
 #### What are some other customer options or leading products that address the same needs?
- ::[Competitor 1](#)
+- ::[Competitor 1](#tbd)
- ::[Competitor 2](#)
+- ::[Competitor 2](#tbd)
- ::[Do-it-yourself solutions](#)
+- ::[Do-it-yourself solutions](#tbd)
 #### Are there any known customers for this product?
- ::[MegaCorp, corporate I.T. department](#)
+- ::[MegaCorp, corporate I.T. department](#tbd)
- ::[Worldwide Global Corporation](#)
+- ::[Worldwide Global Corporation](#tbd)
 - ::Our own in-house application software developers and server
  operations team
 - ::Our own marketing, sales, and customer support departments
--- a/Test-Case-Format.md
+++ b/Test-Case-Format.md
@ -1,4 +1,4 @@
-
+<!-- markdownlint-disable-next-line MD041 -->
 ##### Related Documents
 - [QA Plan](QA-Plan) > [Test Suite](Test-Suite) > Test Case Format
--- a/Test-Cases.md
+++ b/Test-Cases.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
--- a/Test-Run-Suite.md
+++ b/Test-Run-Suite.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
@ -26,7 +27,7 @@ assess risk, and focus ongoing testing efforts.
 - *Review the [target audience](Target-and-Benefits),
  [environmental requirements](SRS#environmental), and [possible
-  deployments](Design-Architecturel#deployment) to understand the
+  deployments](Design-Architecture#deployment) to understand the
  set of possible system configurations that could be tested.*
 - *Use a table or list to describe that set of possible configurations.
  Mark each possibility with Pending, N/A, or Waived.*
--- a/Test-Runs.md
+++ b/Test-Runs.md
@ -1,5 +1,4 @@
-##### Project
+<!-- markdownlint-disable-next-line MD041 -->##### Project
 ::[PROJECT-NAME](Home)
 ##### Internal Release Number
--- a/Test-Suite.md
+++ b/Test-Suite.md
@ -1,3 +1,5 @@
 <!-- markdownlint-disable MD033 -->
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
--- a/Use-Case-Format.md
+++ b/Use-Case-Format.md
@ -1,4 +1,4 @@
-
+<!-- markdownlint-disable-next-line MD041 -->
 ##### Related Documents
 - [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Case Format
--- a/Use-Case-Suite.md
+++ b/Use-Case-Suite.md
@ -1,3 +1,5 @@
 <!-- markdownlint-disable MD033 -->
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
--- a/Use-Cases.md
+++ b/Use-Cases.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::PROJECT-NAME
--- a/User-Guide.md
+++ b/User-Guide.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 *TODO: Fill in information on this product. Make sure to use the
 **product** name and **external** release number, not internal
 information.*
--- a/User-Needs.md
+++ b/User-Needs.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ##### Project
 ::[PROJECT-NAME](Home)
@ -44,7 +45,7 @@ will be hyper-linked from here.
 ### Environment
 *TODO: Briefly describe various aspects of the environment where the
-software will be used. Describe the environment as it *is* or *will be*,
+software will be used. Describe the environment as it \*is\* or \*will be\*,
 not what you would wish it to become. The text below gives a few
 examples.*
@ -182,7 +183,7 @@ it here.*
 *TODO: Write brief user stories to explain how various actors would
 interact with the system (directly and indirectly) to accomplish a
-real-world goal. User stories are *not* use cases: user stories are
+real-world goal. User stories are \*not\* use cases: user stories are
 brief (3-5 sentences) paragraphs that describe one specific scenario in
 concrete terms. In this description of user needs, do not make
 assumptions about details of the system, instead focus on the users.
--- a/Workflows.md
+++ b/Workflows.md
@ -1,3 +1,4 @@
 <!-- markdownlint-disable-next-line MD041 -->
 ### By Activity
 1. Project Planning