News:

  • October 17, 2026, 06:23:11 PM

Login with username, password and session length

Author Topic: A small editing discrepancy and annoyance  (Read 27404 times)

Garyhlucas

  • Hero Member
  • *****
  • Posts: 421
A small editing discrepancy and annoyance
« on: March 17, 2021, 10:43:02 AM »
In the Documentation Editor the Spacebar produces an underline character when typing in the Element name. However when adding a new Element the Spacebar produces a space which is then generates an error message. I think they should both work the same.

Second small annoyance I mentioned a long time ago.  When copying an element the editor adds an underline at the beginning of an Element name and also increments the end of the element.  This then requires you to edit both ends of the new Element which effectively defeats the time savings you get from copying. Just incrementing the end of the Element would be so nice.  The first Element could be Alarm_, the second would then be Alarm_2, Alarm_3 and so on.

BobO

  • Host Moderator
  • Hero Member
  • *****
  • Posts: 6177
  • Yes Pinky, Do-more will control the world!
Re: A small editing discrepancy and annoyance
« Reply #1 on: March 17, 2021, 02:00:50 PM »
In the Documentation Editor the Spacebar produces an underline character when typing in the Element name. However when adding a new Element the Spacebar produces a space which is then generates an error message. I think they should both work the same.

Second small annoyance I mentioned a long time ago.  When copying an element the editor adds an underline at the beginning of an Element name and also increments the end of the element.  This then requires you to edit both ends of the new Element which effectively defeats the time savings you get from copying. Just incrementing the end of the Element would be so nice.  The first Element could be Alarm_, the second would then be Alarm_2, Alarm_3 and so on.

The spacebar to _ was a hack to help folks who kept trying to use spaces, which are unsupported. Yes, it should be that way everywhere, but there is a lot of "everywhere".

That said, with only 16 characters available, I would personally never waste them using underscores. Camel case is more efficient and just as readable.
"It has recently come to our attention that users spend 95% of their time using 5% of the available features. That might be relevant." -BobO

Controls Guy

  • Internal Dev
  • Hero Member
  • ****
  • Posts: 3628
  • Darth Ladder
Re: A small editing discrepancy and annoyance
« Reply #2 on: March 17, 2021, 05:12:28 PM »
Oh yeah, the other day i was meaning to check back in on the 16-character limit.   I know there were plans to increase the limit, is there an ETA for that?
I retract my earlier statement that half of all politicians are crooks.  Half of all politicians are NOT crooks.  There.

BobO

  • Host Moderator
  • Hero Member
  • *****
  • Posts: 6177
  • Yes Pinky, Do-more will control the world!
Re: A small editing discrepancy and annoyance
« Reply #3 on: March 17, 2021, 05:26:47 PM »
Oh yeah, the other day i was meaning to check back in on the 16-character limit.   I know there were plans to increase the limit, is there an ETA for that?

We're doing some work on the display code to facilitate arbitrary lengths. We'll see how that goes before we dig deeper.
"It has recently come to our attention that users spend 95% of their time using 5% of the available features. That might be relevant." -BobO

Controls Guy

  • Internal Dev
  • Hero Member
  • ****
  • Posts: 3628
  • Darth Ladder
Re: A small editing discrepancy and annoyance
« Reply #4 on: March 17, 2021, 05:31:15 PM »
We're doing some work on the display code to facilitate arbitrary lengths. We'll see how that goes before we dig deeper.

Cool, thank you for the update.
I retract my earlier statement that half of all politicians are crooks.  Half of all politicians are NOT crooks.  There.

jrayb

  • Full Member
  • ***
  • Posts: 46
Re: A small editing discrepancy and annoyance
« Reply #5 on: March 17, 2021, 06:54:08 PM »
Can you explain what camel case is?

Controls Guy

  • Internal Dev
  • Hero Member
  • ****
  • Posts: 3628
  • Darth Ladder
Re: A small editing discrepancy and annoyance
« Reply #6 on: March 17, 2021, 07:05:27 PM »
ThisIsCamelCase

(humpy on top like a camel, thought not long-necked like a goose)  ;D
I retract my earlier statement that half of all politicians are crooks.  Half of all politicians are NOT crooks.  There.

RBPLC

  • Hero Member
  • *****
  • Posts: 586
Re: A small editing discrepancy and annoyance
« Reply #7 on: March 17, 2021, 07:07:29 PM »
HeatPump or heatPump vs Heat_Pump or heat_Pump. No underscore to save character space. 

BobO

  • Host Moderator
  • Hero Member
  • *****
  • Posts: 6177
  • Yes Pinky, Do-more will control the world!
Re: A small editing discrepancy and annoyance
« Reply #8 on: March 17, 2021, 07:23:22 PM »
All lower case with underscores was commonly used back in the C programming days, but most use camel case in C++ or Java (my_variable_name vs MyVariableName).
"It has recently come to our attention that users spend 95% of their time using 5% of the available features. That might be relevant." -BobO

jrayb

  • Full Member
  • ***
  • Posts: 46
Re: A small editing discrepancy and annoyance
« Reply #9 on: March 17, 2021, 08:03:09 PM »
Thanks guys!

Garyhlucas

  • Hero Member
  • *****
  • Posts: 421
Re: A small editing discrepancy and annoyance
« Reply #10 on: March 17, 2021, 08:09:49 PM »
I don't write programs for me to understand, I write them for others to understand so I use the underscores to make it very readable.  However I get your point about it, I liked the space bar handling the job.

mhw

  • Hero Member
  • *****
  • Posts: 250
Re: A small editing discrepancy and annoyance
« Reply #11 on: March 19, 2021, 07:11:40 AM »
Camel Case is great until it is imported to Cmore, "ThisIsCamelCase" becomes "THISISCAMELCASE". Please increase the character limit because it is impossible to get AD to make a desired change to Cmore.

Controls Guy

  • Internal Dev
  • Hero Member
  • ****
  • Posts: 3628
  • Darth Ladder
Re: A small editing discrepancy and annoyance
« Reply #12 on: March 19, 2021, 11:06:31 AM »
I don't write programs for me to understand, I write them for others to understand so I use the underscores to make it very readable.  However I get your point about it, I liked the space bar handling the job.

That content confounds me.  It sounds as if camel case would be OK if you were wilting the comments for yourself, but others need underscores, but I can't imagine that's what you're saying.
I retract my earlier statement that half of all politicians are crooks.  Half of all politicians are NOT crooks.  There.

BobO

  • Host Moderator
  • Hero Member
  • *****
  • Posts: 6177
  • Yes Pinky, Do-more will control the world!
Re: A small editing discrepancy and annoyance
« Reply #13 on: March 19, 2021, 11:14:33 AM »
That content confounds me.  It sounds as if camel case would be OK if you were wilting the comments for yourself, but others need underscores, but I can't imagine that's what you're saying.

Clarity is all about what you are used to seeing. There isn't a right or a wrong. I wasn't trying to start a holy war of programming standards, only offering an approach that offers a slight bit more efficiency until we can power through the changes required to render the discussion moot.
"It has recently come to our attention that users spend 95% of their time using 5% of the available features. That might be relevant." -BobO

Controls Guy

  • Internal Dev
  • Hero Member
  • ****
  • Posts: 3628
  • Darth Ladder
Re: A small editing discrepancy and annoyance
« Reply #14 on: March 19, 2021, 11:57:31 AM »
Agreed.  I'm not feeling particularly religious about the camel case vs. underscore thing, just couldn't follow the logic in his post and was hoping for clarification.
I retract my earlier statement that half of all politicians are crooks.  Half of all politicians are NOT crooks.  There.