Shop OBEX P1 Docs P2 Docs Learn Events
All SX-Key Users - Request for Comment — Parallax Forums

All SX-Key Users - Request for Comment

PJMontyPJMonty Posts: 983
edited 2005-11-24 15:16 in General Discussion
At the risk of making my life miserable, I have decided to ask for some public comment on a proposed change to a specific SASM error message. Bean posted a message a few days about an error he got on the following code:

Global EQU 0x0C



The error simply said: Missing label

I did a little research and discovered that "global" is a synonym for "equ" in SASM, hence he was writing the equivalent of:

equ equ 0x0c



So, while the error was factually correct, I feel that it is a bit terse for it's own good. As someone who likes to ramble on (right, Ken?), I decided that the error message might be better if it said this instead:

GLOBAL must have a label in front of it, e.g. MyConst GLOBAL 15



or for EQU:

EQU must have a label in front of it, e.g. MyConst EQU 15




My basic question is whether the existing error message is fine as it is. If not, is my proposed error message helpful or too verbose?

BTW, this is a proposed change. Don't get too upset if it doesn't make the final cut of work to accomplish. Also, please don't flame me with lots of "Don't fix that thing you dope! Fix this important one instead!" I'm working on lots of things, so don't assume I'm not working on your favorite problem/suggestion.
    Thanks, PeterM

Comments

  • CPUMANCPUMAN Posts: 55
    edited 2005-04-04 04:38
    I personaly think the change·is fine.· It is verbose, but I'd take that over trying to guess what the errors means, as you pointed out there is times when it's not completely clear why it's giving an error.

    Thats my $0.02.

    Chris
  • Chris SavageChris Savage Parallax Engineering Posts: 14,406
    edited 2005-04-04 04:39
    Peter,

    ·· The proposed message would be more intuitive.· I certainly can't picture anyone being against the change for any reason.



    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Chris Savage
    Parallax Tech Support
    csavage@parallax.com
  • Guenther DaubachGuenther Daubach Posts: 1,321
    edited 2005-04-04 06:59
    Peter,

    I agree with Chris - the proposed messages are more intuitive.

    IMO, such messages may explain the reason for the errors as clear as possible to give the user an idea what's wrong, instead of having him to read the docs for more information. IOW, it is fine with me when such messages are "verbose" as they normally should not show up anyway smile.gif .

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Greetings from Germany,

    G
  • BeanBean Posts: 8,129
    edited 2005-04-04 11:09
    I'd be happy if it was documented that "Global = EQU", but the proposed error message would be great.
    Bean.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    "SX-Video Display Module" Available Now.

    www.sxvm.com

    "A problem well defined, is a problem·half solved."
    ·
  • PJMontyPJMonty Posts: 983
    edited 2005-04-04 18:57
    Gunther,

    Perhaps you could add the fact that "global" is a synonym for "equ" to the next version of the SXKey manual. It is in the SASM help PDF, but I guess that's not the most popular place for people to look.
      Thanks, PeterM
  • KenMKenM Posts: 657
    edited 2005-04-04 19:38
    Error Message?

    I have never seen one. Every program I have written is perfect the first time. (NOT TRUE, but you already knew that)

    I have no objection to the proposed change.

    ken
  • jfkjfk Posts: 7
    edited 2005-11-11 14:26
    Okay, don't jump on me if this is available, I've been away from SX programming for a couple of years and I'm more that a little fuzzy on everything.....why not have a pdf available that explains every error code in detail?
    I know I can find the list of error codes in the SASM manual, but that doesn't help my poor feeble brain. I would love to have a list of what the error "really" means and possible solutions.
  • LoopyBytelooseLoopyByteloose Posts: 12,537
    edited 2005-11-11 14:57
    A pdf? That seems a bit circular and verbose. After you don't understand the pdf, you might have to issue a second pdf to explain the first and so on.

    I suspect all good programers lapse into neglecting to really write precise, clear error messages. They are more concerned with making the system work and not produce these obscure errors.

    In other words, Edit the error messages to be more self-explanitory. Or, eliminate GLOBAL. Or, both. Keep it simple. AND, KEEP IT COMPACT.

    I really don't want another 1000 pages of pedantic documentation. And I am sure it will expand to 5000 before it is dropped.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    "When all think alike, no one is thinking very much.' - Walter Lippmann (1889-1974)

    ······································································ Warm regards,····· G. Herzog [noparse][[/noparse]·黃鶴 ]·in Taiwan
  • jfkjfk Posts: 7
    edited 2005-11-11 15:11
    Ha!, Thanks Kramer! Sure I don't care...make the error message explain itself, I'm all for that.
    This one would make it easy for me to move on:

    ERROR 59: You are an idiot. This program is not for you.
  • SteveDSteveD Posts: 64
    edited 2005-11-11 16:14
    From a new users perspective. It is difficult to remember everything you read in instruction manuals especially when you are excited about using the product. I believe this is true with most and I am pretty sure that is why most products come with “quick start guides”. I agree the more helpful the better.
  • LoopyBytelooseLoopyByteloose Posts: 12,537
    edited 2005-11-24 15:16
    Jfk,
    I see your point - solution proposals would be nice. I am not sure that they would always be clear.

    For instance,
    I learned Eagle PCB software and I really cannot sort out all the error codes and their validity.
    The board that I designed looks fine and prints fine, but the list of errors makes me feel very stupid.
    I suppose as I really need to know, I will crack their code.

    Sometimes the error codes are their to identify problems at a level that is quite obscure.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    "When all think alike, no one is thinking very much.' - Walter Lippmann (1889-1974)

    ······································································ Warm regards,····· G. Herzog [noparse][[/noparse]·黃鶴 ]·in Taiwan
Sign In or Register to comment.