Skip to content

📖 usage instructions are inconsistent #30

@DerekNonGeneric

Description

@DerekNonGeneric

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.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions