search

TeamAtomECS / AtomECS

Cold atom simulation code
GNU General Public License v3.0
46 stars 12 forks source link

Improve documentation #4

Closed ElliotB256 closed 3 years ago

ElliotB256 commented 3 years ago

We have to redocument the newer classes, as sometimes doc coverage has been lost due to changes (all in the name of progress, which is good :) )

Make sure the final code is consistent with cargo doc --open.

MauriceZeuner commented 3 years ago

right, I have neglected that a bit.

ElliotB256 commented 3 years ago

This can be left until last - but we should make sure the final state is something that a new user could read and understand. We could do this as part of a final code review?

MauriceZeuner commented 3 years ago

sounds good - I will push the fluctuation option tomorrow and whenever you've got time, I'm happy to go through it with you.