Comments Attribute

Feature Requests
1

Since this is not code per se but needs to still be read and understood over time, it would be helpful if there was a "Comments" attribute for most components, queries, transformers, etc.

In the heat of the moment I will know what I am doing when I design things but my later self and others will not have access to my current mental state. Comments would be a good thing to help explain some reasoning or why this particular query has this transformer. Especially since I cannot readily see what uses what.

1 Like
2

There's a "User Documentation" feature which acts like a README. Not as nice as having a notes input on each component but you could start documenting there :))

Especially since I cannot readily see what uses what.

Try the "Query Dependency" tab in the developer console: ctrl / cmd + backtick (`)

1 Like
3

Hey @Gregorio I'm actually building a product for Retoolers that would let you do this :grinning: I'd love to walk you through it.

If you're interested, you can book a quick chat here: Calendly - Ben Gahtan

4

Hi @bengahtan
I happened to go looking today for a way to embed comments/documentation in a component; didn't find it; searched to see if others had talked about it; and found this thread.
What became of your efforts a couple of years ago in this area?
thanks,

5

Hello @libove!

Were you able to book @bengahtan via his calendly? :sweat_smile:

There are a couple options for embedding comment/documentation into a component.

One option is using the 'Comments' component another would be a modal frame or even a split pane.

Some components have 'Tool Tip' inside of their 'Add Ons' when you inspect them, which is for shorter text but can be useful. Let me know if any of these work for your use case or if you have more details on the specifics in mind!