Skip to content

Typo in readme example #3

@jnz86

Description

@jnz86

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions