Skip to content

Valid & Invalid JSON examples #138

@DanielPuthawala

Description

@DanielPuthawala

While incorporating example code of catvars and recipes directly into the documentation to produce a one-stop shop for Cat-VRS documentation is a great idea, it was suggested by @korikuzma at a recent Cat-VRS call that it would be helpful from a pedagogical perspective to additionally include JSON examples that don't validate accompanied by appropriate explanations why in order to head off common learning errors as new developers familiarize themselves with the Cat-VRS specification, and in line with common practice found in, eg, the HGVS nomenclature recommendations, and python package documentation.

Examples of invalid JSON should be added alongside positive examples in the Readthedocs documentation where appropriate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions