search

smiths / caseStudies

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

MG Review - ISSUE #2 - about modules #209

Closed whitere123 closed 5 years ago

whitere123 commented 6 years ago

Hello again @oluowoj ,

This issue is related to the modules in your MG.

In 6.3.5 you should begin by explaining the services abstractly and follow up with some specific examples (as you did with all the other services ). For example, "this module implements operations/algorithms for collisions, such as filtering etc.. " . I think that the overall document would read better this way, as you would be more consistent.

Also, the modules are numerically mislabeled in your hierarchy. For example, in figure 1 you have M10-spatial index and in 6.3.4 you have M12-spatial index.

oluowoj commented 5 years ago

@whitere123, section 6.3.5 has been simplified and your feedback has been added to the document with b48e710. section 6.3.4 M12 - Spatial Index has been removed, it will not be implemented.

Please let me know if ticket can be closed.

whitere123 commented 5 years ago

@oluowoj , yes you can close the issue.