Anyone who has read through the InSim.txt doc, either to make an InSim library or create an InSim app from scratch, knows that parts of the documentation are a bit difficult to parse, because there are many mentions of "see below", but how far below we need to look is not always obvious.
Using a regex search, I found 50 occurrences of "see below", and I believe 14 of them could use some rewording, or directly reference the corresponding enums. The rest are ok as the corresponding info is almost always directly following the "see below" mention.
And a bonus one, may be intended: CAR LIGHTS uses the Switches word everywhere, like CAR SWITCHES - I was just wondering if it should be Lights instead, or if Switches was intended?
Using a regex search, I found 50 occurrences of "see below", and I believe 14 of them could use some rewording, or directly reference the corresponding enums. The rest are ok as the corresponding info is almost always directly following the "see below" mention.
- struct IS_SFP: "Other states must be set by using keypresses or messages (see below) → this one should reference TEXT MESSAGES AND KEY PRESSES
- struct IS_RST: "race flags (must pit, can reset, etc - see below) → biggest offender, you have to scroll 700 lines to find the corresponding info; this should reference the HOSTF_ enum
- struct IS_CNL: leave reason → should mention LEAVR_ enum
- struct IS_LAP, IS_SPX, and IS_PIT: penalty → should mention PENALTY_ enum
- struct IS_PLA: Fact → should mention PITLANE_ enum
- struct IS_CCH: Camera → should mention VIEW_ enum
- struct IS_PEN: OldPen, NewPen, and Reason → should mention PENALTY_ and PENR_ enums
- struct IS_PFL: Flags → should mention PIF_ enum
- struct IS_FIN and IS_RES: Confirm, Flags → should mention CONF_ and PIF_ enums
- struct IS_UCO: UCOAction → no description, should add "see below" and/or mention UCO_ enum
- BUTTONS: "You can also make buttons visible in all screens - see below" → this should probably mention the Inst byte or reference INST_ALWAYS_ON, as the relevant info is buried in the middle of everything else (buttons are a complex subject with dense documentation).
And a bonus one, may be intended: CAR LIGHTS uses the Switches word everywhere, like CAR SWITCHES - I was just wondering if it should be Lights instead, or if Switches was intended?