Remove overlap of comments with private data wire

[francois-normandin]

This is just an annoyance really, but the overlap between the private data wire and the comments at the top of the cases creates kinks in wires when using common quick drop shortcuts.

For example, if I were to bundle some data, and later decide to remove it using Ctrl-R shortcut, it will rewire with a kink for the wire.

Step to reproduce: 1- Bundle data.

2- Select and do Ctrl-Space, Ctrl-R

[jimkring]

@francois-normandin, good point. I'm curious what ideas you might have about how we could fix this?

For example, one could (but maybe should not):

• Use a smaller font for comments (yet, this makes it harder to read)
• Limit comments to a single line (I don't see too much downside to this, although two lines is nice)
• Move comments to upper left corner, instead of in the middle (since the drop-down case selector above the comments takes up a lot of vertical space)
• Move shift registers down a little bit (yet this takes up space often used by the code)
• Increase space (ctrl+drag) between top of case and the data cluster (yet, this violates the best practice of not making the JKI SM bigger)

Thanks!

[francois-normandin]

@jimkring I'm sure you already know which one I prefer :-)

Personally, I always add a few tens of pixels to my JKI SMs at the top to show the dynamic event registration terminals on the Event Structure. I get the added benefit of giving clearance to the text boxes, which is a useful place for a description of the code executing in that frame.

https://www.screencast.com/users/normandinf/folders/Snagit/media/25b49e6c-d68b-412a-9a13-e186ba53dfa0

[jimkring]

Hi @francois-normandin. OK, I think I see what you mean. Is this what you're talking about?

[francois-normandin]

👍

[jlj-ee]

Like @francois-normandin, I always expand the space at the top the event structure in any new JKI SM that I put down. This has a couple aesthetic benefits for me:

1. Room for dynamic event terminals and no wire kinds while using quick drop actions, as noted above.
2. Event case comments can also reside above the cluster wire, as they do in non-event states. That way, they don't get in the way of any code I may have in the event case. Often, there is minimal code because I'll be calling another state, but for certain event types that must be handled in that case (like filter events) it helps a lot to not have the comments in the way. Plus, it adds some visual consistency with the non-event states.

As already noted, it's a very minor annoyance, but @francois-normandin is not alone :)

[jimkring]

Thanks for the weighing in on this @jlj-ee. I'm convinced :-)