search

intel / rohd

The Rapid Open Hardware Development (ROHD) framework is a framework for describing and verifying hardware in the Dart programming language.
https://intel.github.io/rohd-website
BSD 3-Clause "New" or "Revised" License
374 stars 67 forks source link

Rewrite comments on `example/tree.dart` #268

Open chykon opened 1 year ago

chykon commented 1 year ago

Motivation

The comment style in the example/tree.dart example is different from the other examples. Subjectively, it is more difficult for beginners.

Desired solution

Rewrite the comments, linking them to specific code snippets, as done in other examples.

Alternatives considered

Ignore it.

Additional details

No response

chykon commented 1 year ago

Perhaps double slashes should be used instead of triple slashes for comments since there is no need for documentation?

mkorbel1 commented 1 year ago

Good points, thank you for filing!

chykon commented 1 year ago

There is also a doc/TreeExample.md file, the content of which is almost the same as the example/tree.dart example. It may not be needed after the example/tree.dart example has been reworked, or it could be included in tutorials to demonstrate generation capabilities.