Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add descriptions to schema fields #164

Open
jsolbrig opened this issue Apr 10, 2023 · 0 comments · May be fixed by #237
Open

Add descriptions to schema fields #164

jsolbrig opened this issue Apr 10, 2023 · 0 comments · May be fixed by #237
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Improve documenta...

Comments

@jsolbrig
Copy link
Contributor

Requested Update

Description

Each of the fields in the YAML schema should be documented by adding a description field.

Background and Motivation

It would be helpful for developers if each field were documented with a description of what it does.

Alternative Solutions

Maybe this issue should be broken down into multiple issues, one per interface.
@jsolbrig jsolbrig added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 10, 2023
@jsolbrig jsolbrig added this to the v2.0.0 milestone Aug 24, 2023
@jsolbrig jsolbrig linked a pull request Aug 24, 2023 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
Improve documentation and training ma...
Development

Successfully merging a pull request may close this issue.

Update schema descriptions NRLMMD-GEOIPS/geoips
2 participants
@jsolbrig @biosafetylvl5