[myhdl-list] Another typo in docs
Brought to you by:
jandecaluwe
From: Henry G. <he...@ca...> - 2014-05-23 19:48:49
|
Please don't think I'm trying to be annoying with this - I'm having a great time expanding my horizon whilst reading every line of documentation in great detail. Referring to the code in http://docs.myhdl.org/en/latest/manual/rtl.html#finite-state-machine-modeling The reset signal in the testBench() should be initialised to 1 to yield the output expected in gtkwave shown below it. I've pushed the change to my MyHDL fork on bitbucket - as before, PR on demand. Would it make sense to convert the code snippets in the Sphinx documentation to doctests so this can be picked up automatically? I can have a bash at this if desired (certainly, the FSM one above would be useful as a doctest). Also (and separately), is there a reason why the API docs aren't autogenerated with Sphinx autodoc (with the content in the Python docstrings)? Cheers, Henry |