Skip to content

Commit 8dc9e07

Browse files
committed
Revert "Tidy a few markdown lints"
This reverts commit ea043e3.
1 parent ea043e3 commit 8dc9e07

File tree

2 files changed

+16
-17
lines changed

2 files changed

+16
-17
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ add new tests.
2929
[code structure section]: #code-structure
3030
[testing section]: #testing
3131

32-
## Code structure
32+
# Code structure
3333

3434
All types and methods that are available on all tier 1 platforms are defined in
3535
the first level of the source, i.e. `src/*.rs` files. Additional API that is
@@ -55,7 +55,7 @@ Other types are mostly defined in `src/lib.rs`, except for `SockAddr` and
5555
`Socket`, where OS specific methods are defined in `src/sys/*.rs`, e.g.
5656
`Type::cloexec`.
5757

58-
## Testing
58+
# Testing
5959

6060
Testing Socket2 is as simple as running `cargo test --all-features`.
6161

@@ -71,7 +71,7 @@ targets can be installed automatically using `make install_targets` (which uses
7171
[cargo-hack]: https://crates.io/crates/cargo-hack
7272
[rustup]: https://rustup.rs
7373

74-
### Adding a test
74+
## Adding a test
7575

7676
Tests should be added to `tests/socket.rs`, following (roughly) the same order
7777
in which the methods are defined on a type. At the bottom of this file it has a

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,21 @@ See the [API documentation] for more.
1919

2020
[API documentation]: https://docs.rs/socket2
2121

22-
## Branches
22+
# Branches
2323

2424
Currently Socket2 supports the following versions:
25-
26-
* v0.6 developed in the master branch
27-
* v0.5 developed in the [v0.5.x branch]
28-
* v0.4 developed in the [v0.4.x branch]
25+
* v0.6 developed in the master branch
26+
* v0.5 developed in the [v0.5.x branch]
27+
* v0.4 developed in the [v0.4.x branch]
2928

3029
[v0.5.x branch]: https://github.com/rust-lang/socket2/tree/v0.5.x
3130
[v0.4.x branch]: https://github.com/rust-lang/socket2/tree/v0.4.x
3231

33-
## OS support
32+
# OS support
3433

3534
Socket2 attempts to support the same OS/architectures as Rust does, see
36-
[platform support](https://doc.rust-lang.org/nightly/rustc/platform-support.html).
37-
However this is not always possible, below is current list of support OSs.
35+
https://doc.rust-lang.org/nightly/rustc/platform-support.html. However this is
36+
not always possible, below is current list of support OSs.
3837

3938
*If your favorite OS is not on the list consider contributing it!*
4039

@@ -64,18 +63,18 @@ feature flag.
6463
* Solaris
6564
* OpenHarmony
6665

67-
## Minimum Supported Rust Version (MSRV)
66+
# Minimum Supported Rust Version (MSRV)
6867

6968
Socket2 uses 1.70.0 as MSRV.
7069

71-
## License
70+
# License
7271

7372
This project is licensed under either of
7473

75-
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
76-
<https://www.apache.org/licenses/LICENSE-2.0>)
77-
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
78-
<https://opensource.org/licenses/MIT>)
74+
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
75+
https://www.apache.org/licenses/LICENSE-2.0)
76+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
77+
https://opensource.org/licenses/MIT)
7978

8079
at your option.
8180

0 commit comments

Comments
 (0)