Skip to content

Add documentation for model_params, output_variables, and output_header_fields#623

Merged
mattw-nws merged 2 commits into
NOAA-OWP:masterfrom
program--:408-model_params-docs
Sep 6, 2023
Merged

Add documentation for model_params, output_variables, and output_header_fields#623
mattw-nws merged 2 commits into
NOAA-OWP:masterfrom
program--:408-model_params-docs

Conversation

@program--

Copy link
Copy Markdown
Contributor

This PR resolves #408.

Additions

  • Adds documentation for:
    • model_params
    • output_variables
    • output_header_fields

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

@program-- program-- added the documentation Improvements or additions to documentation label Aug 31, 2023
@program-- program-- self-assigned this Aug 31, 2023

@mattw-nws mattw-nws left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not 100% sure about my suggestions, double-check me.

Comment thread doc/BMI_MODELS.md Outdated
Comment thread doc/BMI_MODELS.md Outdated
@program-- program-- force-pushed the 408-model_params-docs branch from 75e1b35 to f246f17 Compare September 5, 2023 21:00
@program-- program-- requested a review from mattw-nws September 5, 2023 21:01
@mattw-nws mattw-nws merged commit 635f44e into NOAA-OWP:master Sep 6, 2023
@program-- program-- deleted the 408-model_params-docs branch May 29, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document model_params and add examples to output_header_fields and output_variables

2 participants