Closed yashasroy closed 5 years ago
I think the main rules are
We need a page in here:
https://authoring.datacamp.com/courses/exercises/all-exercise-types/
I'll try and dig out some examples of really good comments (if that's a thing).
fixed: this is in the style guide
The docs are currently missing best practices on how to write good comments in exercises. This is something that first-time instructors are often confused by, as comments in DataCamp exercises are not like comments in general coding.
My explanation for comments in DataCamp exercises is that they are abbreviated instructions. Some common mistakes made by instructors include:
There are other subtleties as well, such as when to include the variable name that the result must be assigned to, and when not to.