search

cfelton / rhea

A collection of MyHDL cores and tools for complex digital circuit design
MIT License
84 stars 33 forks source link

Reworking docs for the rhea system #42

Closed FelixVi closed 7 years ago

FelixVi commented 7 years ago

First PR including:

  1. Working in all existing files to the docs
  2. Converting docstrings so they show up cleanly in generated docs

Questions: Should we keep the empty doc files register_file and reference to make a template or should those go for now?

Is the style of docstring fine? This is a first test to make sure modifications I make are done the way they should be

In my hands the coverage extension produces empty output files - have you had luck getting that to work? Using it would be nice to verify that all public functions are documented - or at least have a note that they need more docs :)

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 70.364% when pulling 61d5c05d0c789c3a97339192dd5281ec22220164 on FelixVi:docs_system into aae5e3f469f829f26f97387718d23a6d2c4315c1 on cfelton:master.

coveralls commented 7 years ago

Coverage Status

Coverage increased (+0.004%) to 70.369% when pulling 646adbf8238782a79c34daf14df0de2e50a0ee84 on FelixVi:docs_system into aae5e3f469f829f26f97387718d23a6d2c4315c1 on cfelton:master.

coveralls commented 7 years ago

Coverage Status

Coverage increased (+0.004%) to 70.369% when pulling 6491f4f0aca6cba4b40fbe979691f566dac28f55 on FelixVi:docs_system into aae5e3f469f829f26f97387718d23a6d2c4315c1 on cfelton:master.

coveralls commented 7 years ago

Coverage Status

Coverage increased (+0.004%) to 70.369% when pulling 3bb70932371fd26dbbe80dbd38c0422ef99ec509 on FelixVi:docs_system into aae5e3f469f829f26f97387718d23a6d2c4315c1 on cfelton:master.