Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fungible traits: improve api docs #166

Open
liamaharon opened this issue Jun 12, 2023 · 0 comments
Open

fungible traits: improve api docs #166

liamaharon opened this issue Jun 12, 2023 · 0 comments
Assignees
Labels
T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation.

Comments

@liamaharon
Copy link
Contributor

liamaharon commented Jun 12, 2023

          > > Just want to add here, I do not think there is enough education around how to properly work with the [`fungible`](https://paritytech.github.io/substrate/master/frame_support/traits/tokens/fungible/index.html) traits - it can be overwhelming for a newcomer (and at times confusing).

It would be nice to have a playground or have examples that showcases how to use the many different fungible traits.

#225 might help with this. @liamaharon based on the above, would be great if you try and improve the documentation of these APIs, probably add more examples and so on as well.

Sure. I'll create a new issue to track improving the docs, and work on those as I go with the tests. I've tried to include descriptive inline comments in all of the tests so they should be good candidates to include as examples with the help of docify.

_Originally posted by @liamaharon in #186


Documentation for individual methods I think is already pretty good. I feel like part of what can make it overwhelming for new users is they're presented with a bunch of new concepts all at once, with little structure around how they all relate. The traits could probably benefit from top-level docs introducing readers to fungible/s one concept at a time, assuming no prior knowledge.

Note so I don't forget: request review from @brunopgalvao on the eventual MR for this issue.

items to not forget (non-exhaustive)

  • existential deposit and reaping behavior
@liamaharon liamaharon self-assigned this Jun 12, 2023
@juangirini juangirini transferred this issue from paritytech/substrate Aug 24, 2023
@the-right-joyce the-right-joyce added T11-documentation This PR/Issue is related to documentation. T1-FRAME This PR/Issue is related to core FRAME, the framework. and removed I6-documentation labels Aug 25, 2023
@Rashmirreddy Rashmirreddy moved this to To Do in Documentation Sep 11, 2023
jonathanudd pushed a commit to jonathanudd/polkadot-sdk that referenced this issue Apr 10, 2024
* Add cargo deny

* deny - master

* Copy deny.toml to .

* cargo deny check

* upload artifacts

* install cargo deny

* typo

* up install cargo deny

* update archive

* typo

* path's

* allow failure cargo deny

* allew failure log

* cargo deny init

* add deny.toml and compare with embark actions

* fix options

* Fix cargo deny.

* Remove cargo audit (same as deny)

Co-authored-by: Tomasz Drwięga <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation.
Projects
Status: To Do
Status: Backlog
Development

No branches or pull requests

4 participants