Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PCM_VVPlan: Empty Sections #40

Open
elwazana opened this issue May 3, 2018 · 4 comments
Open

PCM_VVPlan: Empty Sections #40

elwazana opened this issue May 3, 2018 · 4 comments
Assignees

Comments

@elwazana
Copy link
Collaborator

elwazana commented May 3, 2018

Sections 1.2, 5.4.4, and 5.4.5 are all blank. Unsure if this is purposeful.

@smiths smiths self-assigned this May 3, 2018
@smiths
Copy link
Owner

smiths commented May 3, 2018

Please include more information on these issues. Reviewing the issue is much easier if I (or anyone else) doesn't have to open the document and look up the different sections. If something is too big to copy and paste, at least include a href to it, so that it is easy for the reader to navigate.

A final piece of advice is to assign all issues to someone. Otherwise, nobody will take ownership. You don't have to worry about assigning the wrong owner, since anyone can change the assignee. As a rule of thumb, issues related to the case studies should be assigned to @smiths and issues related to Drasil code should be assigned to Dr. Carette or Dan. I just realized that neither Dan or Jacques are members of this repo. I'll add them. 😄

For the issue at hand, please include the information on the titles of the sections. Include a link to the document as well, for good measure. 😄

@elwazana
Copy link
Collaborator Author

elwazana commented May 4, 2018

This subsection has no accompanying text

swhs/VVPlan/PCM_VVPlan.tex

Lines 126 to 131 in 0fa29b3

%1.2 Scope
\subsection{Scope}
\bmac{No content... should this be here?}

Both of these subsections also have no accompanying text

swhs/VVPlan/PCM_VVPlan.tex

Lines 500 to 506 in 0fa29b3

\subsubsection{Procedure}
\subsubsection{Preparation}
\bmac{Should these sections be blank?}

These weird "\bmac{~~~}" comments also appear in both excerpts, they appear like so in the pdf
image
image

@smiths
Copy link
Owner

smiths commented Jun 3, 2018

The comments is one way we communicate between the authors of a LaTeX file. They can be turned off in the compiled pdf by setting comments to false (in the tex file). As far as the question about blank sections, when we are following a template, we shouldn't delete a section, even if there isn't any content. If we delete a section, then reviewers do not know if we forgot the section, or mean to remove it. With the way we tend to develop the manual versions of documentation, deleting a section may cause the descendant projects to also be missing the section, even if it would be appropriate for a descendent.

I think we will continue to work on the V&V document. In the mean-time, please delete the \bmac comments that you mentioned above. Also, please add text to the document where there is blanks. For now the text can just To Be Determined.

elwazana added a commit that referenced this issue Jun 4, 2018
@smiths
Copy link
Owner

smiths commented Jun 8, 2018

This issue is related to #80.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants