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.

Sign up for GitHub

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

Jump to bottom

Do some basic improvements #35

Merged
merged 4 commits into from
May 19, 2022
Merged

Do some basic improvements #35

merged 4 commits into from
May 19, 2022

Commits on May 18, 2022

  1. Improve the readme 

    Improve the readme file by doing:

- Use single line per sentence _everywhere_ (this appears to be the
  style but is not applied in all places)
- Remove trailing whitespace
- Use uniform spacing around headings (two spaces before a heading, one after)
- Do minor grammar fixes
- Use backticks for `libbitcoinconsensus`
    @tcharding
    tcharding committed May 18, 2022
    Configuration menu
    Copy the full SHA
    0d22780 View commit details
    Browse the repository at this point in the history

  2. Improve module rustdocs 

    Improve the rustdocs in `lib.rs` by doing:

- Use full stops and capital letters.
- Add module (implies crate) level documentation.
- Document the C FFI call through functions.
- Add HTTP link to libbitcoin-consensus
- Fix code ticks in examples.
- Use 100 character width for comments if more readable
    @tcharding
    tcharding committed May 18, 2022
    Configuration menu
    Copy the full SHA
    8a360c9 View commit details
    Browse the repository at this point in the history

  3. Remove unneeded dead_code attribute 

    This code is not dead, remove the attribute.
    @tcharding
    tcharding committed May 18, 2022
    Configuration menu
    Copy the full SHA
    12b55d3 View commit details
    Browse the repository at this point in the history

  4. Do whitespace fixes 

    Slightly improve the code be adding/removing whitespaces.
    @tcharding
    tcharding committed May 18, 2022
    Configuration menu
    Copy the full SHA
    4943a7d View commit details
    Browse the repository at this point in the history