frc-characterization icon indicating copy to clipboard operation
frc-characterization copied to clipboard

Regarding "Do not omit trailing commas..."

Open virtuald opened this issue 6 years ago • 2 comments

On the readme:

All list values must be lists, even if they have only one element. Do not omit trailing commas (e.g. in (False,)), as this will cause them not to be parsed as a list

Strictly speaking, things surrounded with parentheses are tuples, lists are surrounded by brackets. I tend to use tuples to denote things as immutable, but often lists and tuples are interchangeable.

Why does this matter? Well, [False] is a valid list even without a trailing comma, and so it's a lot harder to mess up. I recommend changing the documentation to use lists (brackets) instead of tuples (parentheses).

virtuald avatar Nov 12 '19 03:11 virtuald

We already made this change in the code; we just haven't updated the documentation to match.

Oblarg avatar Nov 12 '19 03:11 Oblarg

Since the documentation is in frc-docs, shouldn't this issue be renamed (as it would lack some context) and moved there? Assuming that this hasn't been fixed by the docs for this moving into frc-docs.

Starlight220 avatar Sep 16 '20 19:09 Starlight220