docs(tutorial): fix libp2p ping tutorial connection timeout

[pradovic]

Description

There is a special Idle connection timeout section in the ping tutorial which says that we should include connection timeout settings, but the settings are not included.

I have checked previous versions and they had it so it was either lost by mistake, or the section is not relevant anymore.
This is a very minor PR to update the docs.

Notes & open questions

N/A

Change checklist

• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• A changelog entry has been made in the appropriate crates

[elenaf9]

Good catch!
The line was removed in #4967 because the default connection timeout was changed from 0s (connection times out immediately) to 10s.

I think we should keep this section with the readded setting and just fix the following two sentences:

• rust-libp2p/libp2p/src/tutorials/ping.rs

  Line 208 in 6742553

  //! Otherwise, the connection will be closed immediately.

  
  -> //! The default connection timeout is 10 seconds.

• rust-libp2p/libp2p/src/tutorials/ping.rs

  Line 213 in 6742553

  //! Thus, without any other behaviour in place, we would not be able to observe the pings.

  
  -> //! Thus, without any other behaviour in place, we would not be able to observe any pings after 10s.

[pradovic]

Good catch! The line was removed in #4967 because the default connection timeout was changed from 0s (connection times out immediately) to 10s.

I think we should keep this section with the readded setting and just fix the following two sentences:

* https://github.com/libp2p/rust-libp2p/blob/67425531aef5f885efc964b55075d96639d1da7c/libp2p/src/tutorials/ping.rs#L208
  
  -> `//! The default connection timeout is 10 seconds.`

* https://github.com/libp2p/rust-libp2p/blob/67425531aef5f885efc964b55075d96639d1da7c/libp2p/src/tutorials/ping.rs#L213
  
  -> `//! Thus, without any other behaviour in place, we would not be able to observe any pings after 10s.`

I see, it makes 100% sense now. Fixed in 8429e8c. Thank you!

[jxs]

Hi, the rustfmt job is still failing

[pradovic]

Hi, the rustfmt job is still failing

Oups, did not check with nightly 🙈 Fixed. Thanks!

[elenaf9]

Thanks @pradovic!