docs: fix broken links, update documentation #2203
Merged
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
13 tasks
DaniPopes
commented
Feb 27, 2023
| @@ -24,7 +24,7 @@ pub use compile::{ | |||
| }; | |||
|
|
|||
| mod config; | |||
| pub use config::{AllowedLibPaths, PathStyle, ProjectPathsConfig, SolcConfig}; | |||
| pub use config::{AllowedLibPaths, PathStyle, ProjectPaths, ProjectPathsConfig, SolcConfig}; | |||
There was a problem hiding this comment.
ProjectPaths is referenced and exposed in ProjectPathsConfig, but not exported at the crate level, so it failed to document
DaniPopes
commented
Feb 27, 2023
|
|
||
| pub use crate::core::{abi, types, utils}; | ||
| #[doc(inline)] | ||
| pub use ethers_core::{abi, types, utils}; |
There was a problem hiding this comment.
This (#[doc(inline)]) inlines the modules' docs as if we declared them in this scope, instead of being a "re-exported item". This is probably what the previous interface was going for, but this doesn't require duplicating docs and declaring new modules
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.
Motivation
commits:
cargo doc --workspace --all-features --no-deps --document-private-items#![doc = include_str!("../README.md")]in lib.rsSolution
PR Checklist