Skip to content

Commit

Permalink
add verbosity clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
seankim658 committed Jul 18, 2024
1 parent a12bd43 commit 47f36ca
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/templates/documentation_template.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 47f36ca

Please sign in to comment.