Change header for show method from time to t. #473
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
show(interp)
currently displays a table with headerstime
andu
. The actual struct fields aret
andu
, described in the docs as "time" and "data," respectively. I find it confusing because most other tables show the property name. Here it tempts me to tryinterp.time
which does not exist.I propose that the header be changed to
t
, for consistency withu
.Checklist
Additional context
An alternative solution would be to update the
u
header to say "data," so that both headers are qualitative descriptors rather than identifiers.Technically
show
labels multidimensional data asu1
,u2
, etc. which also are not actual identifiers. I think this is reasonable shorthand, lacking a clearly better alternative. Also, the docs mainly emphasize one-dimensional data whereu
header is strictly correct.