Cover the code by docstrings 100%
a5kin opened this issue · comments
100% coverage may be redundant, so let just max it out. The result should be a detailed package documentation, built automatically from docstrings.
Things to document:
- tests.performance
- tests.seeds.test_random
- tests.seeds
- tests.seeds.test_patterns
- tests.bridge.test_base
- tests.bridge
- tests.utils
- tests.utils.test_formatters
- tests.core.test_variables
- tests.core.test_properties
- tests.core.test_base
- tests.core.test_renderers
- tests.core
- tests.core.test_mixins
- tests.core.topology.test_lattice
- tests.core.topology.test_border
- tests.core.topology.test_neighborhood
- tests.core.topology
- xentica
- xentica.seeds.random
- xentica.seeds
- xentica.seeds.patterns
- xentica.bridge.base
- xentica.bridge
- xentica.bridge.moire
- xentica.utils.formatters
- xentica.utils
- xentica.core.base
- xentica.core.variables
- xentica.core.renderers
- xentica.core.properties
- xentica.core.color_effects
- xentica.core
- xentica.core.mixins
- xentica.core.experiment
- xentica.core.exceptions
- xentica.core.topology.neighborhood
- xentica.core.topology.border
- xentica.core.topology.lattice
- xentica.core.topology
- xentica.core.topology.mixins
- examples.game_of_life
It was a hard work, but all docstrings are done at last. We are documented each and every piece of code, paying attention to reStructuredText markup, and examples of classes usage. As the result, we now have a solid API documentation, built automatically from the source code. The only thing left, is to re-organize the contents of documentation files. But let do it in a scope of issue #29.