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: fill out derp documentation #1171

Merged
merged 3 commits into from
Jul 7, 2023
Merged

docs: fill out derp documentation #1171

merged 3 commits into from
Jul 7, 2023

Conversation

ramfox
Copy link
Contributor

@ramfox ramfox commented Jul 5, 2023

No description provided.

@ramfox ramfox added docs Improvements or additions to documentation c-iroh-relay labels Jul 5, 2023
@ramfox ramfox self-assigned this Jul 5, 2023
pub(crate) mod client;
pub(crate) mod client_conn;
pub(crate) mod clients;
/// An http specific Derp Client and Derp Server. Allows for using tls or non tls connection
/// upgrades.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it is nicer to put the module documentation at the beginning of the file using //!

@ramfox ramfox enabled auto-merge (squash) July 7, 2023 14:10
@ramfox ramfox merged commit b98851c into main Jul 7, 2023
15 checks passed
@ramfox ramfox deleted the derp_docs branch July 7, 2023 18:18
@divagant-martian divagant-martian mentioned this pull request Jul 7, 2023
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-iroh-relay docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants