search

GDQuest / godot-guides-v3.0

Work in progress guides and tutorials for the official Godot 3.0 documentation
44 stars 8 forks source link

docs writing guidelines: label "good" and "bad" examples #4

Closed NathanLovato closed 7 years ago

NathanLovato commented 7 years ago

https://github.com/GDquest/godot-3-guides/blob/master/contribution-guides/class-reference-styleguide.md

You give a number of examples, but it isn't immediately obvious which are good and which are bad, at least at a glance. I think each example should be labelled with either Avoid: or Use:.
NathanLovato commented 7 years ago

Done, marked as Do and Don't https://github.com/GDquest/godot-3-guides/commit/b03e4c911c8112924c21b0a5c8bf31af5cbcd3bf