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

*: Remove inject_connected / inject_disconnected from docs #2805

Merged
merged 4 commits into from
Aug 10, 2022
Merged

*: Remove inject_connected / inject_disconnected from docs #2805

merged 4 commits into from
Aug 10, 2022

Conversation

K0UR05H
Copy link
Contributor

@K0UR05H K0UR05H commented Aug 8, 2022

Description

Both inject_connected and inject_disconnected are removed in dc8433e.

Links to any relevant issues

Open Questions

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

@K0UR05H K0UR05H changed the title Remove inject_connected / inject_disconnected in comments Remove inject_connected / inject_disconnected from docs Aug 8, 2022
@thomaseizinger thomaseizinger changed the title Remove inject_connected / inject_disconnected from docs *: Remove inject_connected / inject_disconnected from docs Aug 8, 2022
Copy link
Contributor

@thomaseizinger thomaseizinger left a comment

Choose a reason for hiding this comment

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

Thank you!

One suggestion.

@@ -230,7 +230,7 @@ pub trait NetworkBehaviour: 'static {
/// Informs the behaviour about an event generated by the handler dedicated to the peer identified by `peer_id`.
/// for the behaviour.
///
/// The `peer_id` is guaranteed to be in a connected state. In other words, `inject_connected`
/// The `peer_id` is guaranteed to be in a connected state. In other words, `inject_connection_established`
Copy link
Contributor

Choose a reason for hiding this comment

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

Lets change this and other rustdoc appearances to an actual reference with [``].

That will yield a compile-error if we ever hit this again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for your review. I changed them.

Copy link
Member

@mxinden mxinden left a comment

Choose a reason for hiding this comment

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

Thanks for the help here. Please wrap the lines at 80 or 120 characters. Otherwise, this looks good to me.

Copy link
Member

@mxinden mxinden left a comment

Choose a reason for hiding this comment

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

🙏 Thank you for the help!

@mxinden mxinden merged commit a4110a2 into libp2p:master Aug 10, 2022
@K0UR05H K0UR05H deleted the rm-non-existent branch August 12, 2022 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants