Add documentation to gateware/freq_measurement.py

mithro / HDMI2USB-litex-firmware-old

Opsis SoC based on LiteX

BSD 2-Clause "Simplified" License

1 stars 6 forks source link

Add documentation to gateware/freq_measurement.py #11

Open mithro opened 7 years ago

mithro commented 7 years ago

The old gateware/freq_count.py, despite being more complicated than needed did have a whole bunch of documentation on it. It would be good to add similar documentation to gateware/freq_measurement.py

@enjoy-digital @cr1901

enjoy-digital commented 7 years ago

Agree, but be please pay attention to:

try to write code that is clear, easy to understand (good variables names, less code as possible, ...)
THEN document it (but a code that is clear don't need too much documentation)

Too much documentation is worst than no documentation.

cr1901 commented 7 years ago

Part of the problem with the old module was that I didn't know that migen provided cdc synchronization primitives. I'm not sure what else cdc could stand for, but hindsight is 20/20.