smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

GlassBR Problem Statement Fixes #148

Closed smiths closed 5 years ago

smiths commented 5 years ago

@vajihehm, thank you for submitting the problem statement for GlassBR in issue #147. To help me review your work, can you please do the following:

As you complete these items you can tick them off above. When they are all complete you can close the issue. When closing the issue, please include the commit number that addresses the above points.

vajihehm commented 5 years ago

@smiths,Dr Smith thank you for your items in issue #147.I have some questions about this items : 1- item #1 : It is sufficient that I add Comments.Tex file in BlankProjectTemplate in the ProblemStatement folder where is ProblemStatement.tex without any changes. 2- item #3 : is there any standard for correct spacing for punctuation?

smiths commented 5 years ago

@vajihehm, please do not close the issue until it has been fully addressed. If you still have questions, like those listed above, then you shouldn't close the issue. Your Comments.tex file is in the wrong location. Your file will not compile. You want to follow exactly the example give in the BlankProjectTemplate. The same folder structure and the same folder and file names.

I think you might have misunderstood my comment about spacing for punctuation. All I want you to do is use punctuation following normal grammar rules. For instance, a comma follows a word immediately and then is followed by a single space. A period should have space after it, etc.

When you close this issue, please include the commit hash that points to the commit that completed the work.

vajihehm commented 5 years ago

@smiths Thank you for your response. Frankly , I did not close the issue. I think when I ticked them off, it has been closed automatically.Besides, I made a mistake, I put Comments.tex file in the right location.

smiths commented 5 years ago

@vajihehm, thank you for letting me know about the automatic issue closing feature when using checklists. I was not aware of that. Thank you for fixing the Comments.tex issue. (Please include the hash for the commit so that I can just click on it to see the commit that addresses this issue.) Please address the other issues identified above so that we can close this issue.

vajihehm commented 5 years ago

@smiths Done with 7111606 and ce64b3c

smiths commented 5 years ago

I'm sorry, but you still haven't addressed my comments. I've used the GitHub interface to add comments to the last commit. If you have questions, please let me know.

vajihehm commented 5 years ago

@smiths Thank you for your comments and kind guidance and support. I am writing to let you know while I am getting prepared for the SRS present, I found that I should make some major changes to the content of the problem statement regarding to the project scope. So, I updated the content which will address the comments which you mentioned in my last commit. I hope it would be completely done with c01bc19.

smiths commented 5 years ago

Much better @vajihehm. We can close this issue and officially approve your problem statement.