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.

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

chore: format and standardize all markdowns files #2726

Merged
merged 1 commit into from Apr 29, 2024

Conversation

storopoli
Copy link
Contributor

according to the github flavor
(https://github.github.com/gfm/)

@github-actions github-actions bot added C-bitcoin PRs modifying the bitcoin crate C-hashes PRs modifying the hashes crate C-units PRs modifying the units crate C-internals PRs modifying the internals crate C-io PRs modifying the io crate test doc C-base58 labels Apr 27, 2024
Comment on lines +6 to +8
- `*_hex`: consensus encoded types represented as hex strings
- `*_ser`: consensus encoded types represented as binary data
- `*_bincode`: types serialized with `serde` as bincode
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Opinionated: this should be highlighted as code

Comment on lines +10 to +11
We consensus deserialize, `serde` serialize, then check against the expected data
to verify no `serde` regressions have been introduced.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We already highlight "serde" as inline code, so this is standardizing it.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 8858884788

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 83.131%

Totals Coverage Status
Change from base Build 8849264030: 0.0%
Covered Lines: 19195
Relevant Lines: 23090

💛 - Coveralls


# Fuzzing with weak cryptography
## Fuzzing with weak cryptography
Copy link
Contributor Author

Choose a reason for hiding this comment

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

A markdown file should have only one H1.

Comment on lines +9 to +13
```bash
cargo update -p serde --precise 1.0.156
cargo update -p regex --precise 1.7.3
cargo update -p chrono --precise 0.4.24
```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Opinionated: this should be a fenced block for nice syntax highlighting


The `std::io` module is not exposed in `no-std` Rust so building `no-std` applications which require
reading and writing objects via standard traits is not generally possible. Thus, this library exists
to export a minmal version of `std::io`'s traits which we use in `rust-bitcoin` so that we can
to export a minimal version of `std::io`'s traits which we use in `rust-bitcoin` so that we can
Copy link
Contributor Author

Choose a reason for hiding this comment

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

typo

@@ -23,7 +23,7 @@ Rust Logo is licensed under CC-BY, which allows reuse and modifications for any

## Acknowledgements

Acknowledgement for the runners up in this PR: https://github.com/rust-bitcoin/rust-bitcoin/pull/891#issuecomment-1074476858
Acknowledgement for the runners up in this PR: <https://github.com/rust-bitcoin/rust-bitcoin/pull/891#issuecomment-1074476858>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Automatic formatted by my linter.
We can revert if necessary.

Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK b355740 thanks for going through all this!

Copy link
Member

@tcharding tcharding left a comment

Choose a reason for hiding this comment

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

Sweeet, thanks man!

ACK b355740

@apoelstra apoelstra merged commit bcd2807 into rust-bitcoin:master Apr 29, 2024
168 checks passed
@storopoli storopoli deleted the storopoli/format-md branch April 29, 2024 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-base58 C-bitcoin PRs modifying the bitcoin crate C-hashes PRs modifying the hashes crate C-internals PRs modifying the internals crate C-io PRs modifying the io crate C-units PRs modifying the units crate doc test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants