Skip to content

Commit

Permalink
Merge pull request #413 from carpentries-incubator/fix-good-bad-ugly-…
Browse files Browse the repository at this point in the history
…link

Fix good-bad-ugly comments blog post link
  • Loading branch information
svenvanderburg authored Dec 16, 2024
2 parents 93cda73 + f18d5be commit da6fc57
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion episodes/15-coding-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ unless you are 100% sure the code will never be read by people who do not speak
## The Good, the Bad, and the Ugly Comments

As a side reading, check out the
['Putting comments in code: the good, the bad, and the ugly' blogpost](https://www.freecodecamp.org/news/code-comments-the-good-the-bad-and-the-ugly-be9cc65fbf83/).
['Putting comments in code: the good, the bad, and the ugly' blogpost](https://medium.com/free-code-camp/code-comments-the-good-the-bad-and-the-ugly-be9cc65fbf83).
Remember - a comment should answer the 'why' question".
Occasionally the "what" question.
The "how" question should be answered by the code itself.
Expand Down

0 comments on commit da6fc57

Please sign in to comment.