Skip to content

Decide how to document the data format #15

@kosack

Description

@kosack

Ideally we would like to avoid writing separate documentation and validation tools, as those will be hard to keep in sync.

Options so far:

Option Can generate Documentation Can validate files Note
RST text / tables / document x as done with GADF before
cfitsio templates ? x not sure if stand-alone parser is available outside of ftverify FTOOL
ASDF schemas x x complex to use, but very precise. Support for FITS files is there, but less flexible
Custom Python code like GADF/FITS Schema x could be modified to do docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationquestionFurther information is requested

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions