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

fix(tutorial): import dependencies via meta crate #4949

Merged
merged 2 commits into from
Nov 29, 2023

Conversation

indirection42
Copy link
Contributor

@indirection42 indirection42 commented Nov 28, 2023

Description

Notes & open questions

I'm new to this lib, and I find directly copying the ping example as the tutorial said has some import issues. For example, libp2p_tls is the dependency in the libp2p codebase, but will not be in the application codes only if you specify it. I don't know whether the confusion is a side effect of passing the doctests.

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

@thomaseizinger thomaseizinger changed the title fix(tutorial): fix ping tutorial dependencies to avoid confusion fix(tutorial): import dependencies via meta crate Nov 29, 2023
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! Those is certainly the recommended way to import these. Perhaps we should extract the tutorial into a different crate to avoid these kind of errors.

@thomaseizinger thomaseizinger changed the title fix(tutorial): import dependencies via meta crate chore(tutorial): import dependencies via meta crate Nov 29, 2023
@thomaseizinger thomaseizinger changed the title chore(tutorial): import dependencies via meta crate fix(tutorial): import dependencies via meta crate Nov 29, 2023
@thomaseizinger thomaseizinger added the internal-change Pull requests that make internal changes to crates and thus don't need to include a changelog entry. label Nov 29, 2023
@mergify mergify bot merged commit dfd66f9 into libp2p:master Nov 29, 2023
71 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal-change Pull requests that make internal changes to crates and thus don't need to include a changelog entry. send-it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants