Add 'missing_docs' attribute to dummy package #4992
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
bkchr
approved these changes
Jul 11, 2024
lexnv
approved these changes
Jul 16, 2024
|
Review required! Latest push from author must always be reviewed |
bkchr
approved these changes
Jul 17, 2024
Merged
via the queue into
paritytech:master
with commit Jul 17, 2024
72030ce
156 of 160 checks passed
jpserrat
pushed a commit
to jpserrat/polkadot-sdk
that referenced
this pull request
Jul 18, 2024
We want to add linter to the entire node based on a template. Just like
`cargo clippy -- --deny missing_docs`. And we have the error (pasted at
the end).
The dummy crate is used to test whether the WASM toolchain is installed
and working as expected. And for some reason this dummy crate included
as a target for the linter. I added an attribute to pass the check.
```
note: To improve backtraces for build dependencies, set the CARGO_PROFILE_DEV_BUILD_OVERRIDE_DEBUG=true environment variable to enable debug information generation.
Caused by:
process didn't exit successfully: `/Users/hrls/src/atleta/target/debug/build/atleta-runtime-b15153eff20cbe96/build-script-build` (exit status: 1)
--- stderr
Rust WASM target for toolchain stable-aarch64-apple-darwin is not properly installed; please install it!
Further error information:
------------------------------------------------------------
Compiling dummy-crate v1.0.0 (/var/folders/h1/_5gdnk8901n959lc28fwx8400000gn/T/.tmpUQCLaV)
error: missing documentation for the crate
--> src/main.rs:1:1
|
1 | fn main() {}
| ^^^^^^^^^^^^
|
= note: requested on the command line with `-D missing-docs`
error: could not compile `dummy-crate` (bin "dummy-crate") due to 1 previous error
------------------------------------------------------------
```
Co-authored-by: Bastian Köcher <[email protected]>
TarekkMA
pushed a commit
to moonbeam-foundation/polkadot-sdk
that referenced
this pull request
Aug 2, 2024
We want to add linter to the entire node based on a template. Just like
`cargo clippy -- --deny missing_docs`. And we have the error (pasted at
the end).
The dummy crate is used to test whether the WASM toolchain is installed
and working as expected. And for some reason this dummy crate included
as a target for the linter. I added an attribute to pass the check.
```
note: To improve backtraces for build dependencies, set the CARGO_PROFILE_DEV_BUILD_OVERRIDE_DEBUG=true environment variable to enable debug information generation.
Caused by:
process didn't exit successfully: `/Users/hrls/src/atleta/target/debug/build/atleta-runtime-b15153eff20cbe96/build-script-build` (exit status: 1)
--- stderr
Rust WASM target for toolchain stable-aarch64-apple-darwin is not properly installed; please install it!
Further error information:
------------------------------------------------------------
Compiling dummy-crate v1.0.0 (/var/folders/h1/_5gdnk8901n959lc28fwx8400000gn/T/.tmpUQCLaV)
error: missing documentation for the crate
--> src/main.rs:1:1
|
1 | fn main() {}
| ^^^^^^^^^^^^
|
= note: requested on the command line with `-D missing-docs`
error: could not compile `dummy-crate` (bin "dummy-crate") due to 1 previous error
------------------------------------------------------------
```
Co-authored-by: Bastian Köcher <[email protected]>
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.
We want to add linter to the entire node based on a template. Just like
cargo clippy -- --deny missing_docs. And we have the error (pasted at the end).The dummy crate is used to test whether the WASM toolchain is installed and working as expected. And for some reason this dummy crate included as a target for the linter. I added an attribute to pass the check.