Skip to content
This repository has been archived by the owner on Mar 13, 2023. It is now read-only.

Add #![warn(missing_docs)]? #1276

Closed
boundless-forest opened this issue Jun 10, 2022 · 3 comments
Closed

Add #![warn(missing_docs)]? #1276

boundless-forest opened this issue Jun 10, 2022 · 3 comments
Assignees
Labels
P-Low [Priority] Low

Comments

@boundless-forest
Copy link
Member

Long-term, requiring additional documentation can be beneficial.

@AurevoirXavier
Copy link
Member

AurevoirXavier commented Jun 10, 2022

We can start this on some of our custom pallets.

@boundless-forest
Copy link
Member Author

boundless-forest commented Sep 27, 2022

There is a related issue darwinia-network/darwinia-docs-deprecated#304. Prefer to enhance the code docs in our customed pallet first, especially for items Const, Extrinsic, and Storage, then sync the code notes to the darwinia-docs website.

We can do this after the parachain backing and ethereum-related pallets have been cleaned up.

@hackfisher
Copy link
Contributor

darwinia-common could be deprecated after darwinia 2.0.

The request is good, but should be an common practice and conversion instead.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
P-Low [Priority] Low
Projects
None yet
Development

No branches or pull requests

3 participants