Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Adding docs to macros and fixeing rust lint warnings #64

Merged
merged 1 commit into from Nov 29, 2019

Conversation

dr-orlovsky
Copy link
Contributor

@dr-orlovsky dr-orlovsky commented Sep 26, 2019

New versions of rust compiler fails to build the crate due to the absent docs for some macros. They also produce some lint warning. This PR fixes the problem.

Sample of the failed build before the fixes applied: https://travis-ci.org/rust-bitcoin/bitcoin_hashes/builds/589871443?utm_source=github_status&utm_medium=notification

UPDATE: Had to roll back some of the linting improvements which were not supported by the current stable rustc version

@dr-orlovsky dr-orlovsky changed the title Adding docs to macros and fixes rust lint warnings Adding docs to macros and fixeing rust lint warnings Sep 26, 2019
Copy link
Collaborator

@stevenroose stevenroose left a comment

Choose a reason for hiding this comment

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

LGTM

@dr-orlovsky
Copy link
Contributor Author

Can we merge this thing pls to unlock #63 which is it's dependence?

@apoelstra
Copy link
Member

Why is the diff so big? Is there a purpose to reordering these methods to no longer be in alphabetical order?

@dr-orlovsky
Copy link
Contributor Author

  1. The reason of method reordering is that compiler asks (via warning) that the order of the methods has to be the same like in the trait specification.
  2. The size of the diff: it's not big, it just contains the changes requested by the compiler warnings, i.e. new single-line doc-style comments for the macros that had not them + re-ordering of the impl methods to the order used in the trait declarations.

@dr-orlovsky
Copy link
Contributor Author

This PR is blocking #63, required for further processing with hash_newtypes, which are nearly done for rust-bitcoin: rust-bitcoin/rust-bitcoin#349

@stevenroose
Copy link
Collaborator

My compiler doesn't complain about the order of methods. I guess if you would limit the PR to the doc and not change the order, it could get merged without any hassle..

cargo 1.39.0 (1c6ec66d5 2019-09-30)

@dr-orlovsky
Copy link
Contributor Author

Done

@apoelstra apoelstra merged commit 2b1dfe3 into rust-bitcoin:master Nov 29, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants