chuckwagoncomputing / interactive-pinout

Interactive Pinout Generator
MIT License
8 stars 5 forks source link

add validation of "type" field values #16

Closed mi-hol closed 9 months ago

mi-hol commented 9 months ago

There should be a list of allowed values for "type" field in documentation. Meaning of the type values should be explained there too. Used values should be validated against defined list in order to avoid errors in definition.

As I understand it, the currently allowed value list and meaning seems to be:

chuckwagoncomputing commented 9 months ago

The "types" are defined by the project using interactive-pinout, e.g. for rusEFI in https://github.com/rusefi/rusefi/blob/master/.github/workflows/gen-pinouts.yaml. I agree that documenting these could be useful for the rusEFI project, however, this repo is not the place to do it.

mi-hol commented 9 months ago

@chuckwagoncomputing please reopen, because currently "types" the referenced file are really hard to understand. A better reference is needed from my view that should be included or linked in the using repos. The "table" in first comment was the first trial to improve this unresolved open topic. (see https://github.com/rusefi/rusefi/pull/5802#discussion_r1428839997)