-
Notifications
You must be signed in to change notification settings - Fork 9
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
Prepare for initial 1.0 alpha version #162
base: 1.x
Are you sure you want to change the base?
Conversation
5e927dc
to
18ed434
Compare
18ed434
to
a002401
Compare
I may have mentioned it already but I don't have much confidence in iterators. I remember when I tried to change something I ran into issues. Can we please only have the error types and two inherent functions? (I could also accept the trait.) |
ed55fbe
to
aabe779
Compare
Moved some of the |
@apoelstra shall I make a |
src/iter.rs
Outdated
@@ -194,6 +194,7 @@ where | |||
/// Generally you shouldn't need to refer to this or bother with it and just use | |||
/// [`HexToBytesIter::new`] consuming the returned value and use `HexSliceToBytesIter` if you need | |||
/// to refer to the iterator in your types. | |||
#[doc(hidden)] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this hidden and not non-pub/deleted?
Yep. |
After sleeping on this the following thought came to me: If we are using See rust-bitcoin/rust-bitcoin#3935 for the same in |
@tcharding because if anybody (including us) actually uses the |
aabe779
to
99dae5a
Compare
We don't know what 1.0 is going to look like. For the alpha releases just remove the `examples` directory all together.
26574a7
to
4bbf256
Compare
We do not know exactly what 1.0 is going to look like. For now remove the `prelude` module.
In preparation for releasing a bare-bones 1.0 version of this crate add two stand alone crate level functions that decode a hex string into a vector and an array.
In preparation for releasing `v1.0` gut the crate. Delete everything not used and make anything else private except the error types and two new decoding functions.
In preparation for doing the first 1.0 alpha release set the version number, add a changelog entry, and update the lock files.
4bbf256
to
ef4111f
Compare
Open question: I have no idea how we will re-introduce stuff back into this from another branch and have reviewable patches? |
|
Any 1.0 -> 0.x should only happen by adding |
It might look a little weird in git. Normally you don't "move" code between branches like this.
But yeah, agreed. We're all pretty good at using git here and we'll figure it out. |
Oh, true, one commit deletes it another adds it. We will need to link them somehow at least. |
We would like to release a
v1.0-alpha
that contains the bare minimum of code so that we can use it inprimitives
.decode_vec
anddecode_array
Please allow me to explicitly leave improving docs to be done as part of the alpha release cycles.
Close: #154