You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The first line of the code snippet in the “Usage” (instructions) section of the README.md file of this repository state that the imported function is named mdTable2json as can be seen below; when in reality, the name of this particular function is mdTbl2json.
import{mdTable2json}from'@openinf/util-md-table';
I have struggled with deciding whether it makes sense to abbreviate or not, as we still have no style guide dictating whether abbreviations like this are acceptable but should be relatively easy to fix.
The rationale for tbl is that it is a very commonly-used way of abbreviating “table” especially in Visual Basic style guides, which many users of this particular module would hopefully appreciate.
The text was updated successfully, but these errors were encountered:
The code example just below the problematic import uses a joiner of \n, but depending on the platform, it may be worthwhile to use something like the following.
import{EOLasnewlineMarker}from'node:os';constsampleTable=['| Col1 | Col2 | Col3 | Col4 |','|:-----:|:-----:|:-----:|:-----:|','| one | two | three | four |','| Fee | Fie | Foe | Fum |',].join(newlineMarker);
DerekNonGeneric
changed the title
📖🐞 usage instructions are wrong
📖 usage instructions are wrong
Mar 17, 2022
The first line of the code snippet in the “Usage” (instructions) section of the
README.md
file of this repository state that the imported function is namedmdTable2json
as can be seen below; when in reality, the name of this particular function ismdTbl2json
.I have struggled with deciding whether it makes sense to abbreviate or not, as we still have no style guide dictating whether abbreviations like this are acceptable but should be relatively easy to fix.
The rationale for
tbl
is that it is a very commonly-used way of abbreviating “table” especially in Visual Basic style guides, which many users of this particular module would hopefully appreciate.The text was updated successfully, but these errors were encountered: