smiths / caseStudies

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

Comments on Projectile Motion, Part 3 #245

Closed JacquesCarette closed 2 years ago

JacquesCarette commented 3 years ago

Here are, at a higher level, the things that would be nice to also make explicit:

smiths commented 3 years ago

This issue is related to #247.

smiths commented 2 years ago

Commit 1a7b1c7, together with previous commits closes this issue.

Learning objectives and explicit assumptions have been added. The inputs are separated into knowns and unknowns. The steps for solving a projectile motion problem are made explicit and linked throughout the example. I've also removed any print statements that weren't adding new information.

With respect to outputs, they can be displayed on their own (as is done for the answers), but they cannot be incorporated (as far as I can tell) into the markdown text documentation.