ref: Change module structure and visibility and require docs #1176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This modifies the modules inside the crate structure and visibility. Specifically it moves the `config` and `command` modules from the iroh *crate* into the iroh *binary*. This could be a little confusing. This means they are no longer part of the public API of the iroh crate (and do not need to be documented). It also fills in a few odd bits of missing doc comments and makes doc comments required for public APIs on the crate.
Comment on lines
-8
to
-12
|
|
||
| #[cfg(feature = "cli")] | ||
| pub mod commands; | ||
| #[cfg(feature = "cli")] | ||
| pub mod config; |
There was a problem hiding this comment.
looks cleaner to me
dignifiedquire
approved these changes
Jul 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This modifies the modules inside the crate structure and visibility.
Specifically it moves the
configandcommandmodules from the irohcrate into the iroh binary. This could be a little confusing.
This means they are no longer part of the public API of the iroh
crate (and do not need to be documented).
It also fills in a few odd bits of missing doc comments and makes doc
comments required for public APIs on the crate.
When reviewing: the crux are the changes to
main.rsandlib.rs.