regex icon indicating copy to clipboard operation
regex copied to clipboard

release regex-capi 1.0

Open davidblewett opened this issue 5 years ago • 3 comments

The 1.0 version of regex was released just shy of a year ago: https://github.com/rust-lang/regex/issues/457 . I would like to stabilize the rure-python bindings at 1.0.

You mentioned doing an audit of the API; is there something I can assist with?

davidblewett avatar Apr 08 '19 11:04 davidblewett

I think the audit is something like this:

  • Looking at the issue tracker for anything related to regex-capi. (There isn't much, I don't think.)
  • Carefully review the public API documented in rure.h along with the implementation. In particular, does the documentation of relevant contracts match the implementation?
  • Scan the rure source code for any relevant TODOs.
  • Think holistically about whether the API is right or not.

My guess is that the existing API can be marked as 1.0 without any changes. But the above process is a sanity check before committing to a 1.0. While it's true that a 2.0 can always be released to fix things, I generally like to treat 1.0 as some kind of commitment to stability measured at the level of ~years.

BurntSushi avatar Apr 08 '19 11:04 BurntSushi

@BurntSushi is this something you would like me to help with? I can probably help with 1-3; not sure about 4.

davidblewett avatar Apr 08 '19 17:04 davidblewett

Honestly, it's probably something I'd want to at least do myself. It's hard to farm out this kind of work unfortunately. Of course, having folks go through the above steps in addition to me would be very helpful since additional perspectives are great for this kind of stuff, especially from someone who is actually using it. :-)

BurntSushi avatar Apr 08 '19 17:04 BurntSushi