diff --git a/src/templates/documentation_template.hbs b/src/templates/documentation_template.hbs index d9c0f82..e124b12 100644 --- a/src/templates/documentation_template.hbs +++ b/src/templates/documentation_template.hbs @@ -29,4 +29,6 @@ Documentation style guide and guidelines to follow: Comments should use the style for their language (i.e. Python docstrings use """, Rust docstrings use ///, Typescript and Javascript use /** */, and so on). Any potential variable comments should be placed directly above the variable and any docstring comments should be placed right below the class/function/method definition. -Also note if you see any existing documentation that seems to be potentially conflicting or contradictory to the code it describes. Let me know if you have any questions and please review your work before finishing. +Also note if you see any existing documentation that seems to be potentially conflicting or contradictory to the code it describes. + +If the existing code is already well documented and there are no improvements that wouldn't cause unnecessary verbosity then just say so. Don't force unnecessarily verbose documentation. Let me know if you have any questions or if you require additional context or other code in order to write accurate documentation. Please review your work before finishing.