Skip to content

Tutorial walkthrough of parser creation could be clearer for Windows environments #804

@ersnow42

Description

@ersnow42

The tutorial currently provides example commands of format hatch run scripts:create-parser "foo" "01/bar", which doesn't appear to work on Windows environments. I found I needed to run hatch run win-scripts:create-parser "foo" "01/bar" which was evident only from inspecting the available environments with hatch env.

image

Also, the tutorial file could offer a little more guidance on the schema regex for the parser creation script (in the case that the schema already exists).
In many places in src\allotropy\allotrope, such as schema_mappers, models, and schema_parsers, the schemas use underscores in their names (plate_reader).
In the actual schema JSON file, and the schemas folder in general, they use hyphens (plate-reader).
It might be helpful to include some more information in the tutorial on specifically which files the regex should target, and probably good to describe a little more the logic of why the date is used in the example (to specifically select a certain version of the schema.)

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions