Skip to content

Improve docs and readme (#93)#101

Merged
cjtu merged 1 commit into
mainfrom
docs
Sep 17, 2025
Merged

Improve docs and readme (#93)#101
cjtu merged 1 commit into
mainfrom
docs

Conversation

@cjtu
Copy link
Copy Markdown
Owner

@cjtu cjtu commented Sep 17, 2025

Several improvements suggested in #93

  • added link to read more about CRS
  • cleaned up code snippets to be mostly copy/paste runnable (provides required imports in each subsection of the readme/getting_started examples)
  • added some tips for customizing plots and reference to the cartopy/matplotlib docs
  • added a note about how crater tables aren't typically PDS standardized and how to deal with ambiguous input crater data
  • added a benchmark to the end of the getting_started docs page

@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.52%. Comparing base (685ac4b) to head (86b5e7a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #101   +/-   ##
=======================================
  Coverage   95.52%   95.52%           
=======================================
  Files           4        4           
  Lines         447      447           
  Branches       54       54           
=======================================
  Hits          427      427           
  Misses         11       11           
  Partials        9        9           

☔ 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.

@cjtu cjtu merged commit d17afb6 into main Sep 17, 2025
7 checks passed
@cjtu cjtu deleted the docs branch September 17, 2025 06:21
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.

1 participant