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.

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

MRG: add comment about semver and column headings #3433

Merged
merged 1 commit into from
Dec 16, 2024
Merged

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Dec 15, 2024

This PR updates the docs to make it clear that we may rearrange or add columns within major versions, and suggests that people parse based on CSV headings.

Fixes #3432

@ctb
Copy link
Contributor Author

ctb commented Dec 15, 2024

ready for review & merge @sourmash-bio/devs

@ctb ctb enabled auto-merge (squash) December 15, 2024 13:25
Copy link

codecov bot commented Dec 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.43%. Comparing base (d814ba7) to head (215941c).
Report is 1 commits behind head on latest.

Additional details and impacted files
@@            Coverage Diff             @@
##           latest    #3433      +/-   ##
==========================================
- Coverage   86.44%   86.43%   -0.02%     
==========================================
  Files         137      137              
  Lines       16103    16103              
  Branches     2219     2219              
==========================================
- Hits        13920    13918       -2     
- Misses       1876     1878       +2     
  Partials      307      307              
Flag Coverage Δ
hypothesis-py 25.43% <ø> (ø)
python 92.40% <ø> (ø)
rust 62.14% <ø> (-0.07%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Contributor

@bluegenes bluegenes left a comment

Choose a reason for hiding this comment

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

Lgtm

@ctb ctb merged commit d22b860 into latest Dec 16, 2024
43 of 44 checks passed
@ctb ctb deleted the doc_semver_cols branch December 16, 2024 14:50
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.

document column name stability in output CSVs for semantic versioning
2 participants