rohd icon indicating copy to clipboard operation
rohd copied to clipboard

Rewrite comments on `example/tree.dart`

Open chykon opened this issue 2 years ago • 3 comments

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 avatar Feb 13 '23 11:02 chykon

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

chykon avatar Feb 13 '23 11:02 chykon

Good points, thank you for filing!

mkorbel1 avatar Feb 13 '23 18:02 mkorbel1

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.

chykon avatar Mar 21 '23 10:03 chykon