-
Notifications
You must be signed in to change notification settings - Fork 4
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
0.3.2 contains a breaking change (new parameter to lex
)
#60
Comments
That makes sense. The 0.3.x releases will have a lot of breaking changes as the library works toward common mark compliance. |
Rust crates are generally expected to follow cargo's variant of the semver spec in which |
This is a pre 1.0.0 library and is considered unstable for the time being. I am making no promises of backwards compatibility for the time being and if you read the status section of my readme file you'll see a line stating
Perhaps I could be more clear that interfaces are also considered unstable. Let me know if that would be useful.
You're welcome to use other software 👍 |
Even pre-1.0.0 libraries generally have expectations on them in the Rust ecosystem like following semver.
Yes, you would need to specify also the API, that you are not following semver (according to cargo). The thing that isn't clear to me is what is the value of publishing if this isn't being setup for people to use by following semver. |
I've updated the readme to indicate that interfaces are also considered unstable. For your own edification the current semver spec defines |
From https://semver.org/#spec-item-4
Yes, the semver spec says that which is why I've been specifically calling out cargo's variant of semver From https://doc.rust-lang.org/cargo/reference/resolver.html#semver-compatibility
|
is there anything else I can do for you beyond updating the readme? |
The statement is still unclear
Generally, people will refer to pre-1.0 crates as unstable. A more clear "this project is not following semver, use |
That was my thinking as well. |
That wasn't quite what I meant. The refer to pre-1.0 crates as "unstable" despite expecting no breaking changes between patch releases. The term "unstable" is very context-dependent on how people will read into it, so in the context it is being used people will not get the intended meaning from it. |
I follow the semver.org thinking on my pre 1.0.0 releases; anything can change at anytime. For my project the 0.3.x releases will be used as steps toward common mark compliance. If that's not useful to you then you're welcome to pin a version or to use a different piece of software. |
Noticed this when dependabot tried to upgrade my survey of markdown parsers: rosetta-rs/md-rosetta-rs#14
The text was updated successfully, but these errors were encountered: