Skip to content

always use fits KEYWORD name for element name? #6

@kosack

Description

@kosack

fits_schema supports having a separate element name from the header keyword name. Should we use that to define nicer element names that can be longer than 8 characters? e.g. should we write:

Re-use the same element and keyword name:

class BibliographicHeader(Header):
    """The creator of this data product."""

    ORIGIN = HeaderCard(
        description="Organization or institution responsible for this file.",
        type_=str,
        reference=Ref.fits_v4,
        examples=["CTAO ERIC"],
    )
...

or, use a nice element name, and specify keyword name?

class BibliographicHeader(Header):
    """The creator of this data product."""

    organization = HeaderCard(
        keyword="ORIGIN",
        description="Organization or institution responsible for this file.",
        type_=str,
        reference=Ref.fits_v4,
        examples=["CTAO ERIC"],
    )

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions