# A thought about using comments in node description

**URL:** <https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934>\
**Category:** General\
**Created:** [31 March 2020 01:57 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934 "2020-03-31T01:57:43Z")\
**Posts on this page:** 10\
**Page:** 1

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [31 March 2020 01:57 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/1 "2020-03-31T01:57:44Z")

</div>

This is just a _putting it out there_ post with something I think would be nice to share as an idea.

Although (most) nodes allow comments to be added to them it is not always thought of, and there is a `comment` node too.

I use the `comment` node here and there to remind me of what a block of nodes are doing, and there is little else.

But now and then there is **more** information there than what is in the title.  
I've decided to implement the _rule_ that if there are extra (any?) comments in the node's comment field, I append an `*` to the name.

That will indicate to me that there is more there than shown.

Eg:

 ![Screenshot from 2020-03-31 12-51-16](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/3X/8/b/8b87ac0e6a668c83663659e2c3515d2442389787.png)

I know to open that node and read the extra stuff in the comments.

---

<div class="post-metadata">

**Author:** ![dceejay](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/dceejay/32/38_2.png) [@dceejay](https://discourse.nodered.org/u/dceejay)\
**Post date:** [31 March 2020 06:53 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/2 "2020-03-31T06:53:39Z")

</div>

You shouldn't need to open it. Just selecting it will show the info in the info sudebar

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [31 March 2020 08:14 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/3 "2020-03-31T08:14:10Z")

</div>

I nearly replied but thought I should test your claim.

Not happening here on my machine.

When I move my mouse over the `comment` node, it turns to a hand, and that's about it.

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [31 March 2020 08:15 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/4 "2020-03-31T08:15:43Z")

</div>

> [@Trying\_to\_learn](#):
>
> When I move my mouse over the `comment` node, it turns to a hand, and that's about it.

Moving your mouse over the comment node is not the same as selecting it.

_Click_ on the node and you will see its info in the Info sidebar - just as you would any other node.

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [31 March 2020 08:16 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/5 "2020-03-31T08:16:19Z")

</div>

Node selected or not, I only get the hand.

No _pop up comments_ visible.

I just tried to take two screen shots to show this, but the mouse is lost in the captures.

But believe me: I don't get the pop up text.

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [31 March 2020 08:19 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/6 "2020-03-31T08:19:20Z")

</div>

> [@Trying\_to\_learn](#):
>
> But believe me: I don't get the pop up text.

No one has said anything about pop-up text.

Dave said:

> selecting it will **show the info in the info sudebar**

I said:

> _Click_ on the node and you will **see its info in the Info sidebar**

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [31 March 2020 08:24 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/7 "2020-03-31T08:24:09Z")

</div>

Ok, my bad on that.

But again: (and after making a fool of myself for not reading what was written) I select the node, and nothing in the side bar either.

(Which _mode_ does it need to be in? I'm guessing debug)

Oh.... No. Of course not. It has to be in **info** mode.

Yeah, well, ok. Fair enough.

This is a suggestion for people to use (or not).

Most of the time I have the side bar in debug mode. _Information_ mode is irritating as every time you click somewhere that part of the display changes. (For no real gain)

So as opposed to changing to mode from _debug_ to _information_ to see it - which means more mouse travel from the node to the menu button.

My way is the mouse is at/near/on the node. Double click and read the text.

Again: It is only a suggestion.

And I shall cop the two _dunce_ points I copped in my replies.

---

<div class="post-metadata">

**Author:** ![Steve-Mcl](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/steve-mcl/32/4826_2.png) [@Steve-Mcl](https://discourse.nodered.org/u/Steve-Mcl)\
**Post date:** [31 March 2020 08:44 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/8 "2020-03-31T08:44:22Z")

</div>

Andrew, yeah, you definately need to deduct 2 points there

however, in yor defence, you are definitely not alone.

I often have to write `double click me to read more` in the comment. Its quite difficult to succinctly explain `click me, expand the side bar if hidden, and select the info tab to read more`.

Nick / Dave, as a UX improvement, perhaps you might consider adding to bottom of your long list of TODOs - generating a tooltip that either says "look in the side bar info tab for more info" or better still (and slightly more difficult due to MD rendering) display all or part of the internal info in a tooltop?

I would personally raise a PR however I tried this once for a UI element in NR and almost immediately floundered due to the i18n implications (everything sounds simple until you give it a go right?)

[edit]  
Just thought, perhaps if clicking a comment (with additional info), the sidebar (if hidden) opened out & the info TAB auto selected?

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [31 March 2020 08:46 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/9 "2020-03-31T08:46:54Z")

</div>

Thanks @Steve-Mcl.

I guess "double click me to read more" is good also.

Just my way you can put a brief description in the `comment` node and append a `*` to indicate there is more to read if you open the node.

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/1X/d073cd938eafa2e558d7c2cd59003b3ef4963033.png) [@system](https://discourse.nodered.org/u/system)\
**Post date:** [30 May 2020 08:47 UTC](https://discourse.nodered.org/t/a-thought-about-using-comments-in-node-description/23934/10 "2020-05-30T08:47:13Z")

</div>

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.