search

Atleta-network / atleta

GNU General Public License v3.0
7 stars 4 forks source link

Deny missing docs #107

Closed hrls closed 1 month ago

hrls commented 1 month ago

https://github.com/Atleta-network/atleta/pull/89#discussion_r1633844250

There are no other rules that work the same way as failed pipeline. 😈

ales-tsurko commented 1 month ago

Maybe we should enable it as a warning in the Cargo.toml lint’s section instead?

hrls commented 1 month ago

Unfortunately we have error in sdk source for runtime package check. There is dummy crate created during the build phase, but somehow included in the clippy targets list. So as is workaround is to relax missing_docs check for node and runtime packages for now.

hrls commented 1 month ago

Maybe we should enable it as a warning in the Cargo.toml lint’s section instead?

Cargo.toml lints section works only per package. We can add lints section for existing packages tomls, but it will be missed someway for new ones. IMO missing_docs warning is hard to use in dev-mode. We always want use as simple as cargo clippy without extra mess like -- -A missing_docs when typing.

Caused by:
  failed to parse manifest at `/Users/hrls/src/atleta/Cargo.toml`

Caused by:
  this virtual manifest specifies a `lints` section, which is not allowed
ales-tsurko commented 1 month ago

sorry, accidentaly edited your last comment

well, it's about personal preferences. for my own project's I always enable warn missing docs and clippy all lints and ok with the warnings 😄 but it seems like we don't have other options here rather then doing it in CI.

these warnings are especially useful when you have configured your editor with inline alerts

hrls commented 1 month ago

I'll check if this can be configured via clippy.toml. missing_docs is cargo check lint, but maybe it will works.