Shorthand Data Representation in Context Help

[JackDunaway]

A Context Help annoyance: when I hover over an enum, it graciously provides a wealth of information about the datatype I have chosen for the enum. So much information, actually, that the information I'm after - the items - are cut off by the window. How about a shorthand data representation?

[JackDunaway]

P.S. - When I see all that crap on the screen "unsigned word [16-bit integer (0 to 65535)]", my brain has to translate it into something it can use anyway.... "Oh, U16." 🙂

[Manzolli]

For me it's not crap at all. Many times I need to know details about the data and don't like to go to the Help to find out, it's nice have it in the Context Sensitive Help.

What I like about your idea is that you pointed a problem. I think the most important information should came first, next the complementary. How about using two lines? Here is a suggestion:

-------------------------------------------------------------------

Enum

No description available

[<>] Enum U16 enum (Item 1, Item 2,Item 3,Item 4)

        unsigned word [16-bit integer (0 to 65535)]

-------------------------------------------------------------------

Let's discuss! Kudos!!!

PS.: I didn't put a graphical version because I use Firefox. To insert pictures pictures here I have to open IE...

[Darren]

Kudos for you.  If we have trouble getting consensus, it seems like the long vs. short description could be a configurable option.

-D

[AristosQueue (NI)]

Funny... when I first started in LV, one of the first projects I was assigned was to expand the description of the numerics in the context help because we had multiple reports from customers who didn't understand the computer science terminology that was all that we had before. I've never been sure whether I like all that detail or not, but I do have to admit to using the range information from time to time -- having it right in the CH has been sometimes useful.

Manzolli: Whatever the solution, it has to fit on a single line, otherwise displays of arrays, clusters, queues, objects, notifiers, datalogs, and user events become harder, not easier, to read.

Message Edited by Aristos Queue on 03-24-2010 09:07 AM

[JackDunaway]

---

Aristos Queue wrote:

...I do have to admit to using the range information from time to time...

---

Yeah, I use the range information also occasionally. I never even think to look in CH however - I just type 99999999999999999 into the datatype and see what the constant caps at.

"From time to time" is the keyword here - that makes detailed representation information a perfect candidate for "Detailed Help". 98 times of 100, I don't want it in the Context Help, and the 2 times out of 100 I could click Detailed Help.

[JackDunaway]

Cross-posting a great Idea that could also increase visual SNR: Collapsible Nodes in Context Help. If the data description occupied the second column of a tree control, this Idea becomes less necessary!

[SteenSchmidt]

Even the shorthand string could be way too long (I often have 10+ items in enums), so what about having the shorthand string as default, and then the long version as a tooltip when hovering over it with the mouse pointer? A tooltip can expand beyond the context help window frame.

Cheers,

Steen

[dthor]

I'm fine with the shorthand string (U16 vs unsigned word), but I really like having the limits there. I can never bloody remember how big a I16 or U23 can get, and I don't want to bust out a calculator to figure it out 

I am also partial to having the info on two lines, as per Manzolli's suggestion.