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

docs: remove mentions of old API components #172

Merged
merged 2 commits into from
Aug 20, 2023
Merged

Conversation

Gowee
Copy link
Contributor

@Gowee Gowee commented Aug 17, 2023

Control and Connection::next_stream has been removed since 0.11 and 0.12, in favor of poll-based methods on Connection.

The PR updated doc comments regarding those structs. Some outdated non-doc comments at the top of connection.rs (L12) are unchanged, because I am not familiar with the crate enough to rewrite that part.

This fixes #171.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
…rol`
@thomaseizinger thomaseizinger changed the title Update doc comments regarding Connection and Control docs: remove mentions of Control Aug 17, 2023
@thomaseizinger thomaseizinger changed the title docs: remove mentions of Control docs: remove mentions of old API components Aug 17, 2023

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
- The internals are outdated.
- Still references control mechanism.
- The improvements are not worth exploring.
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 d0d9d66 into libp2p:master Aug 20, 2023
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.

Doc for v0.12.0 is outdated
2 participants