[MISC] add brief note that TSV example in the spec may currently use either tab or space characters #643
Conversation
Original example in .md looks like tab separated since its rendition is ugly, but it is just that -- spaces were not used, not tabs. Just so it might come handy (may be there is a command for that) to display spaces and tabs for content in clipboard you could use smth like $> xsel -o | sed -e 's, ,·,g' -e 's,\t,⇰,g' onset·duration⇰response_time⇰correct⇰stop_trial⇰go_trial 200⇰200⇰0⇰n/a⇰n/a⇰n/a%
More work needs to be done to make it all uniform and factually correct. In "theory" markdown sources should use tabs. HTML (and PDF) rendering should provide nice rendition of those while layouting into a proper tabular presentation and using some unicode characters to depict tab symbols. For now -- note should suffice
|
I feel like this should be an issue outlining the problem --> if all agree that all TSV examples in the spec should be formatted using tabs, then we would want a follow up PR that fixes all examples. |
|
The tsv examples in the spec are only a few lines long and I think it would
be more effective to have a link to an actual real tsv file wth tabs
rather than expecting that people are going to cut and paste the toy
examples. I find it very difficult to understand what the various values
correspond to when the column values don't line up --- especially since
these values can have blanks in them.
…On Sun, Oct 25, 2020 at 5:12 AM Stefan Appelhoff ***@***.***> wrote:
I feel like this should be an issue outlining the problem --> if all agree
that all TSV examples in the spec should be formatted using tabs, then we
would want a follow up PR that fixes all examples.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#643 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAJCJOWFNIY3JV7UGNAMXYDSMP2YFANCNFSM4SJI3YIA>
.
|
some issue beyond he one I have referenced? (#644)
Good idea, but again a more "global one" -- to allow spec to point to good examples (not only for .tsv files but whole datasets, other types of files etc) from external links. We already have references to various aspects, and have linkchecker validating their validity. If there is no issue yet, please start one?
yeap, I am with you on this one. in #644 I outlined a possible solution at the level of "renderer" of the spec from source (which imho should use tabs) into visual form (html or pdf). The problem now that there is no consistency. This PR at least tries to bring some consistency within the "common principles" description (where fields iirc do not align visually anyways but also simply incorrect by using spaces instead of tabs). |
There was a problem hiding this comment.
some issue beyond he one I have referenced? (#644)
no that one is perfect - I just overlooked it, sorry :)
Co-authored-by: Stefan Appelhoff <[email protected]>
sappelhoff
changed the title
|
Thanks everyone. |
Inspired by realization while discussing now merged #619
See individual commits description for more information. A satellite issue on harmonization of tsv examples
will be filed shortly#644