coala / coala/documentation

docs: use doctests

Open
#57 3 comments 0 reactions 0 assignees View on GitHub
area/documentation status/stale
Dominant language
Python
Stars
40
Forks
172
PR merge metrics
No merged PRs in 30d

Description

_From @Redridge on February 15, 2016 11:40_

In order for the docs to be correct, the code that the docs contain must be correct.
For that matter the docs should be all doctest stable. [doctest](https://pytest.org/latest/doctest.html)
Rewrite/Imporve the docs such that they use doctest

difficulty/low

_Copied from original issue: coala-analyzer/coala#1498_

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.