question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add new 💭emoji for adding / modifying informative comments in code

See original GitHub issue

Hello @carloscuesta 😎!

  • Emoji: 💭
  • Code: :thought_balloon:
  • Description: “Adding or updating comments in code”

Although in ideal programming world code should be self descriptive, reality shows that sometimes it is really helpful to introduce some context info or short explanation of decisions made in code.

Taking above into consideration I propose to introduce emoji 💭identifying commits where comments were added to code or modified.

Currently there is not such an emoji, the closest ones are:

  • 📝 or 💡 - but documentation is something different then comment
  • ♻️ - but it is not always about refactoring
  • 🍻 - if we discuss all the how’s and why’s in pub or sth 😉

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:6
  • Comments:6 (1 by maintainers)

github_iconTop GitHub Comments

7reactions
Hunter71commented, Jan 9, 2020

@MarcoGorelli ok then, I can see it can cause confusion. So what about changing description of 💡to clearly distinct it from 📝 ?

For example change it to description I proposed here: “Adding or updating comments in code”

It will be backward compatible (😄) and remove confusion which one use for documenting and which for code comments.

4reactions
MarcoGorellicommented, Jan 8, 2020

To be honest this is what I thought 💡 was for. I’ve been using 📝 for documentation (including docstrings) and 💡 for source code comments

Read more comments on GitHub >

github_iconTop Results From Across the Web

erikthedeveloper/code-review-emoji-guide - GitHub
A simple emoji legend to help convey intention and added meaning in code review comments. A picture is worth 1,000 words. An emoji...
Read more >
How to Use Actionable Emojis in Your Pull Request Reviews
Love them or hate them, emojis ensure our pull request comments include the intended tone, something easily lost in written communication.
Read more >
Guidelines for Submitting Unicode® Emoji Proposals
This page describes the process and requirements for submitting a proposal for new emoji characters or emoji sequences, including how to submit a...
Read more >
How to Insert Emoji in Visual Studio Code Editor While Writing ...
How to Insert Emoji in Visual Studio Code Editor While Writing Source Code Using Emoji SnippetsLink of the Extension Used in the ...
Read more >
How Emoji Can Improve Your Code—Seriously - TJ VanToll
Great post 😎 I love using emoji in commit messages but never thought to use them in code comments. It definitely aids readability...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found