[SRS] Updated SRS Documentation #532
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: mya <hussam52@mcmaster.ca> Co-authored-by: Ayushi Amin <amina23@mcmaster.ca> Co-authored-by: tbrar06 <brart5@mcmaster.ca> Co-authored-by: Nivetha Kuruparan <niv.kuru@gmail.com>
As per the feedback received on avenue, changes were made to the SRS tex file to ensure that tables and figrues were properly referenced with captions and working links. Preambles to the related sections and subsections were also added to allow such referencing since some subsections only contained a diagram/table. The revision table was updated to reflect these changes. closes #271
In accordance to the TA's feedback, moved the glossary section up in the document to rigth below the Purpose of the Project (Section 1). closes #270
Forgot to delete the original glossary when addressing feedback
Created table of symbolic constants at the begining of the document and used them in place of their hard values throughout the document.
…r and UseAGenerator Refactor (#317)
Co-authored-by: mya <hussam52@mcmaster.ca> Co-authored-by: Sevhena Walker <83547364+Sevhena@users.noreply.github.com> Co-authored-by: Ayushi Amin <66652121+Ayushi1972@users.noreply.github.com>
Co-authored-by: mya <hussam52@mcmaster.ca> Co-authored-by: Ayushi Amin <66652121+Ayushi1972@users.noreply.github.com> Co-authored-by: Sevhena Walker <83547364+Sevhena@users.noreply.github.com>
Co-authored-by: mya <hussam52@mcmaster.ca> Co-authored-by: Nivetha Kuruparan <167944429+nivethakuruparan@users.noreply.github.com> Co-authored-by: Sevhena Walker <83547364+Sevhena@users.noreply.github.com> Co-authored-by: Nivetha Kuruparan <niv.kuru@gmail.com> Co-authored-by: Ayushi Amin <amina23@mcmaster.ca> Co-authored-by: Ayushi Amin <66652121+Ayushi1972@users.noreply.github.com> Co-authored-by: tbrar06 <brart5@mcmaster.ca> Co-authored-by: Tanveer Brar <92374772+tbrar06@users.noreply.github.com>
Co-authored-by: Nivetha Kuruparan <niv.kuru@gmail.com> Co-authored-by: Ayushi Amin <66652121+Ayushi1972@users.noreply.github.com> Co-authored-by: Nivetha Kuruparan <167944429+nivethakuruparan@users.noreply.github.com> Co-authored-by: Tanveer Brar <92374772+tbrar06@users.noreply.github.com>
Ayushi1972
added
documentation
Ayushi1972
requested review from
Sevhena,
mmyaaaaa,
nivethakuruparan and
tanveer-brar
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated all sections of SRS doc while implementing all feedback given for it.
How Has This Been Tested?
Compiled Locally