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

Enhance the MET User's Guide to better describe ASCII file lists #3066

Closed
16 of 21 tasks
JohnHalleyGotway opened this issue Jan 28, 2025 · 0 comments · Fixed by #3067
Closed
16 of 21 tasks

Enhance the MET User's Guide to better describe ASCII file lists #3066

JohnHalleyGotway opened this issue Jan 28, 2025 · 0 comments · Fixed by #3067
Assignees
@JohnHalleyGotway
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: Community General Community type: task An actionable item of work
Milestone
MET-12.1.0

Comments

@JohnHalleyGotway
Copy link
Collaborator

Describe the Task

As noted in the dtcenter/METplus#2686 discussion, the description of ASCII file lists, used by several MET tools, is lacking. This to is to clarify their definition and usage.

Time Estimate

2 hours.

Sub-Issues

Consider breaking the task down into sub-issues.
None

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

METplus User Support key

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required: @DanielAdriaansen to review

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as a MET-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a MET-X.Y.Z version, select the MET-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: MET-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@JohnHalleyGotway JohnHalleyGotway added component: documentation Documentation issue priority: medium Medium Priority requestor: Community General Community type: task An actionable item of work labels Jan 28, 2025
@JohnHalleyGotway JohnHalleyGotway added this to the MET-12.1.0 milestone Jan 28, 2025
@JohnHalleyGotway JohnHalleyGotway self-assigned this Jan 28, 2025
JohnHalleyGotway added a commit that referenced this issue Jan 28, 2025
@JohnHalleyGotway
Per #3066, add Data-IO section about file lists and reference it in a…
e83f873 
…ll tools that use them.
@JohnHalleyGotway JohnHalleyGotway linked a pull request Jan 28, 2025 that will close this issue
Feature #3066 file_list_docs #3067
Merged
17 tasks
@github-project-automation github-project-automation bot moved this to 🩺 Needs Triage in METplus-6.1.0 Development Jan 28, 2025
@JohnHalleyGotway JohnHalleyGotway moved this from 🩺 Needs Triage to 🔎 In review in METplus-6.1.0 Development Jan 28, 2025
JohnHalleyGotway added a commit that referenced this issue Jan 30, 2025
@JohnHalleyGotway
Per #3066, update usage statements in the docs and application code b…
d217ac1 
…ased on PR feedback.
JohnHalleyGotway added a commit that referenced this issue Jan 30, 2025
@JohnHalleyGotway
Per #3066, missed a handful of additional updates.
1ac0c1e
JohnHalleyGotway added a commit that referenced this issue Jan 31, 2025
@JohnHalleyGotway @DanielAdriaansen
Feature #3066 file_list_docs (#3067)
8766403 
* Per #3066, add Data-IO section about file lists and reference it in all tools that use them.

* Per #3060, fix typo

* Update docs/Users_Guide/data_io.rst

Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>

* Update docs/Users_Guide/data_io.rst

Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>

* Per #3066, update usage statements in the docs and application code based on PR feedback.

* Per #3066, missed a handful of additional updates.

---------

Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in METplus-6.1.0 Development Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JohnHalleyGotway JohnHalleyGotway

Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: Community General Community type: task An actionable item of work
Projects
METplus-6.1.0 Development
Status: 🏁 Done
Milestone
MET-12.1.0
Development

Successfully merging a pull request may close this issue.

Feature #3066 file_list_docs dtcenter/MET
1 participant
@JohnHalleyGotway