Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo in readme example #3

Open
jnz86 opened this issue Sep 8, 2022 · 0 comments
Open

Typo in readme example #3

jnz86 opened this issue Sep 8, 2022 · 0 comments

Comments

@jnz86
Copy link

jnz86 commented Sep 8, 2022

Missing a comma in readme example.

2.3.2: There can be many instances of the state machine [snip]

[snip]

For example:

    CAMERA basic;
    HSM_Create((HSM *)&basic name, &CAMERA_StateOff);

There should be a comma between &basic and name. Two arguments. Also, it wouldn't hurt that where basic is defined as a camera type to also delcare a const string name there too, for clarity.

Sidenote: Great documentation. I read the whole thing and only saw this one error. Unlikely, but I would love for you to fill in the other advanced examples. As well as update the ascii diagrams to PlantUML style.


Additionally, HSM.h line 95
// Use this macro to supress debug messages for a single call of HSM_Run (e.g. frequent timer events)
Suppress is spelled wrong


And again, hsm.c line 80
// Suppress warning for unused variable if HSM_FEATURE_DEBUG_ENABLE is not defined
Same issue with suppress

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant