Check for all functions that documentation and tests agree #215
Labels
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
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.
The text was updated successfully, but these errors were encountered: