Check for all functions that documentation and tests agree #215

gustavdelius · 2021-08-21T11:48:17Z

Every aspect of a function that is documented should be tested. That way we will never break things unexpectedly that the user has a right to expect will work. I expect that we will need to add a lot more tests.

Conversely, if a behaviour is being tested, then that behaviour should be something the reader of the documentation will expect. I suspect that while looking over the tests we will get ideas of how to clarify the documentation.

Here is an alphabetical list of currently exported functions, so that we can check off any where we are happy with both documentation and tests.

…roposed in #215 and promptly found a bug. The test checking that the new species stays at its low abundance is failing.

gustavdelius added code improvement This issue relates to code quality rather than user-facing features documentation Issue relates to documentation help wanted We are looking for someone to help with this issue labels Aug 21, 2021

gustavdelius added a commit that referenced this issue Aug 21, 2021

Went through the exercise of making documentation and tests agee as p…

73a470c

…roposed in #215 and promptly found a bug. The test checking that the new species stays at its low abundance is failing.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check for all functions that documentation and tests agree #215

Check for all functions that documentation and tests agree #215

gustavdelius commented Aug 21, 2021 •

edited

Check for all functions that documentation and tests agree #215

Check for all functions that documentation and tests agree #215

Comments

gustavdelius commented Aug 21, 2021 • edited

gustavdelius commented Aug 21, 2021 •

edited