Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

meta-schemas: Descriptions or no descriptions? #175

Closed
Labels
Priority: Low clarificationItems that need to be clarified in the specification
Milestone
@handrews

Description

hyper-schema.json has descriptions for its fields. json.schema does not. We should pick one or the other appraoch.

In favor of descriptions:

  • It makes the meta-schema something of a quick-ref guide

Problems with descriptions:

  • Easily get out of sync with the specification
  • Long strings are annoying in JSON, but short descriptions can leave out important parts while giving a false sense of security to people who do not read the actual spec or longer tutorials.

I prefer no descriptions, but I'd be OK with adding descriptions everywhere.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Priority: Low clarificationItems that need to be clarified in the specification

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      AltStyle によって変換されたページ (->オリジナル) /