Fix 0.2 documentation
a5kin opened this issue · comments
We already have a solid documentation for new 0.2 features. But anyway, it should be double checked, fixed and enhanced as necessary.
To not get lost, there is a list of files to check:
- xentica/init.py
- xentica/bridge/init.py
- xentica/bridge/base.py
- xentica/bridge/moire.py
- xentica/core/init.py
- xentica/core/base.py
- xentica/core/color_effects.py
- xentica/core/exceptions.py
- xentica/core/experiment.py
- xentica/core/expressions.py
- xentica/core/mixins.py
- xentica/core/parameters.py
- xentica/core/properties.py
- xentica/core/renderers.py
- xentica/core/variables.py
- xentica/core/topology/init.py
- xentica/core/topology/border.py
- xentica/core/topology/lattice.py
- xentica/core/topology/neighborhood.py
- xentica/seeds/init.py
- xentica/seeds/patterns.py
- xentica/seeds/random.py
- xentica/tools/init.py
- xentica/tools/color.py
- xentica/tools/genetics.py
- xentica/tools/rules.py
- xentica/tools/xmath.py
- xentica/utils/init.py
- xentica/utils/formatters.py
- examples/init.py
- examples/base.py
- examples/evolife.py
- examples/game_of_life.py
- examples/noisetv.py
- examples/shifting_sands.py
- docs/index.rst
- docs/api/xentica.bridge.rst
- docs/api/xentica.core.rst
- docs/api/xentica.core.topology.rst
- docs/api/xentica.seeds.rst
- docs/api/xentica.tools.rst
- docs/api/xentica.utils.rst
- docs/manual/installation.rst
- docs/manual/testing.rst
- docs/manual/tutorial.rst
Xentica documentation is corrected and ready. Mostly, it was typos and grammar corrections. Some API corrections (params' descriptions etc.) were made too. Nothing actually was added or removed, we've already done a good job with docs. Now, proceeding straight to the package release.