Skip to content

Commit 5175b36

Browse files
committed
core: Ignore diagrams and outdated examples from doc tests
Signed-off-by: Alexandru Vasile <[email protected]>
1 parent ced265d commit 5175b36

File tree

4 files changed

+5
-3
lines changed

4 files changed

+5
-3
lines changed

.github/workflows/rust.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,6 @@ jobs:
2424
- uses: actions/checkout@v3
2525
- name: Build
2626
run: cargo build --verbose
27+
2728
- name: Run tests
2829
run: cargo test --verbose

cli/src/commands/authorities.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ impl AuthorityDiscovery {
437437
/// However, the address cannot be reached directly.
438438
/// For this to work, we'd need to implement NAT hole punching.
439439
///
440-
/// ```rust
440+
/// ```ignore
441441
/// let addr =
442442
/// "/ip4/34.92.86.244/tcp/40333/p2p/12D3KooWKxsprneVYQxxPnPUwDA5p2huuCbZCNyuSHTmKDv3vT2n";
443443
/// let addr: Multiaddr = addr.parse().expect("Valid multiaddress; qed");

subp2p-explorer-core/src/types/multiaddr.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ impl<'a> From<Protocol<'a>> for Multiaddr {
242242
///
243243
/// Example:
244244
///
245-
/// ```rust
245+
/// ```ignore
246246
/// use sc_network_types::build_multiaddr;
247247
/// let addr = build_multiaddr!(Ip4([127, 0, 0, 1]), Tcp(10500u16));
248248
/// ```

subp2p-explorer/src/notifications/handler.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ pub enum NotificationsHandlerToBehavior {
114114
///
115115
/// ### Transitions
116116
///
117+
/// ```ignore
117118
/// Closed -> OpenDesiredByRemote
118119
/// |
119120
/// |
@@ -122,7 +123,7 @@ pub enum NotificationsHandlerToBehavior {
122123
/// |--------------- behavior ack
123124
/// |
124125
/// OpenDesiredByRemote -> Opening -> Open
125-
///
126+
/// ```
126127
pub enum State {
127128
/// Protocol is closed.
128129
Closed {

0 commit comments

Comments
 (0)