Skip to content

Fix userguide example in quickstart#129

Merged
hkershaw-brown merged 3 commits intomainfrom
fix-userguide-examples
Jan 22, 2026
Merged

Fix userguide example in quickstart#129
hkershaw-brown merged 3 commits intomainfrom
fix-userguide-examples

Conversation

@hkershaw-brown
Copy link
Copy Markdown
Member

@hkershaw-brown hkershaw-brown commented Jan 22, 2026

  • Quickstart uses example from pydartdiags package data.
  • Added detail on composite observations in user guide to show default composite vs. providing your own yaml.

fixes #124

updated the quickstart.rst so the output matches the obs_seq.final.1000
data

parital fix for #124
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.12%. Comparing base (2ecb485) to head (bcf03db).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #129   +/-   ##
=======================================
  Coverage   64.12%   64.12%           
=======================================
  Files           5        5           
  Lines        1115     1115           
=======================================
  Hits          715      715           
  Misses        400      400           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hkershaw-brown hkershaw-brown changed the title Fix userguide in quickstart Fix userguide example in quickstart Jan 22, 2026
Copy link
Copy Markdown
Collaborator

@mjs2369 mjs2369 left a comment

Choose a reason for hiding this comment

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

I think the desription of multi-component obs and how to specify them with the yaml file (if not wanting the default) is much clearer and sufficiently fixes the comment made on issue #124

I pushed a commit which I think works better for introducing the get_example_data function in the quickstart. But feel free to remove it if you disagree.

@hkershaw-brown
Copy link
Copy Markdown
Member Author

nice addition thanks Marlee!

@hkershaw-brown hkershaw-brown merged commit 74959f7 into main Jan 22, 2026
2 checks passed
@hkershaw-brown hkershaw-brown deleted the fix-userguide-examples branch January 22, 2026 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unable to Run Through Quickstart Commands in Documentation

3 participants