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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs.rs badge to readme #122

Merged
merged 1 commit into from Jul 30, 2022
Merged

Conversation

philpax
Copy link
Contributor

@philpax philpax commented Jul 30, 2022

When looking at a crate's README, I usually look for the docs.rs badge at the top, and assume that it doesn't have docs otherwise. I thought that was initially the case with wonnx, but then I noticed the link to the docs later in the readme. Figured I'd add the badge to stop others from making the same assumption I did 馃憣

@haixuanTao haixuanTao merged commit f6882c1 into webonnx:master Jul 30, 2022
@haixuanTao
Copy link
Collaborator

Thanks :)

@haixuanTao
Copy link
Collaborator

Just for info, I'm not sure if the doc on docs.rs is up to date. :S sorry

@pixelspark
Copy link
Collaborator

It is, but for the last released crate (v0.2.4, 7 months old). We should release a new one!

@SludgePhD
Copy link
Contributor

There have been many breaking changes since 0.2.4, so the new version should have been 0.3, not 0.2.5

@philpax philpax deleted the patch-1 branch July 31, 2022 16:50
@pixelspark
Copy link
Collaborator

pixelspark commented Jul 31, 2022

There have been many breaking changes since 0.2.4, so the new version should have been 0.3, not 0.2.5

Not according to semantic versioning: for major version zero (0.x.y), anything may change at any time, public API is not considered stable. Cargo specifically implements SemVer logic, but does consider versions 0.X.Y compatible when X is equal.

Publishing v0.3.0 and yanking v0.2.5 would still be legal according to SemVer and would not break users relying on X<0 compatibility. While I personally frown upon cargo's deviance from SemVer here, I would be fine with doing it this way.

@pixelspark
Copy link
Collaborator

@SludgePhD v0.2.5 now yanked, v0.3.0 published.

@SludgePhD
Copy link
Contributor

Yeah, sadly not doing what Cargo does here would wreak havoc on all downstream crates, so there's not much of a choice

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.

None yet

4 participants