search

samuelbryant / sjb-tools

A simple CLI program to create, maintain and edit todo lists
MIT License
0 stars 0 forks source link

Use a consistent paradigm for writing doc strings #11

Open samuelbryant opened 6 years ago

samuelbryant commented 6 years ago

I have seen projects with rigid type markup in docstrings. I have also seen projects that have rigid typing using decorators.

Both of these might be overkill, especially if there is unit testing. But we I should at least consider the idea

samuelbryant commented 6 years ago

Note: Check out the openrazer project's typedefs

samuelbryant commented 6 years ago

After some research it has been decided to use an automated doc tool. An earlier recommendation given here is to use Sphinx