[improve docs]: Template pallet #1280
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
sacha-l
added
A1-insubstantial
sacha-l
requested review from
aaronbassett,
kianenigma,
wentelteefje,
AlexD10S and
Rashmirreddy
gilescope
approved these changes
Aug 30, 2023
AlexD10S
approved these changes
Aug 30, 2023
Co-authored-by: Squirrel <gilescope@gmail.com>
wentelteefje
approved these changes
Aug 30, 2023
|
The CI pipeline was cancelled due to failure one of the required jobs. |
added 3 commits
August 31, 2023 13:42
BradleyOlson64
approved these changes
Sep 2, 2023
ordian
added a commit
that referenced
this pull request
Sep 7, 2023
* master: (25 commits) Markdown linter (#1309) Update `fmt` file and some authors (#1379) Bump the known_good_semver group with 1 update (#1375) Bump proc-macro-warning from 0.4.1 to 0.4.2 (#1376) feat: add futures api to `TransactionPool` (#1348) Ensure cumulus/bridges is ignored by formatter and run it (#1369) substrate: chain-spec paths corrected in zombienet tests (#1362) contracts: Update to wasmi 0.31 (#1350) [improve docs]: Template pallet (#1280) [xcm-emulator] Unignore cumulus integration tests (#1247) Fix wrong ref counting (#1358) Use cached session index to obtain executor params (#1190) fix typos (#1339) Use bandersnatch-vrfs with locked dependencies ref (#1342) Bump bs58 from 0.4.0 to 0.5.0 (#1293) Contracts: `seal0::balance` should return the free balance (#1254) Logs: add extra debug log for negative rep changes (#1205) Added short-benchmarks for cumulus (#1183) [xcm-emulator] Improve hygiene and clean up (#1301) Bump the known_good_semver group with 1 update (#1347) ...
Daanvdplas
pushed a commit
that referenced
this pull request
Sep 11, 2023
* add and refactor docs * commit mistake * improvements * fixes * Apply suggestions from code review Co-authored-by: Squirrel <gilescope@gmail.com> * fix: use markdown syntax * from review: explain what generate_deposit does * from review: add note about errors * updates * fix: bring back getter --------- Co-authored-by: Squirrel <gilescope@gmail.com>
bgallois
pushed a commit
to duniter/duniter-polkadot-sdk
that referenced
this pull request
Mar 25, 2024
* add and refactor docs * commit mistake * improvements * fixes * Apply suggestions from code review Co-authored-by: Squirrel <gilescope@gmail.com> * fix: use markdown syntax * from review: explain what generate_deposit does * from review: add note about errors * updates * fix: bring back getter --------- Co-authored-by: Squirrel <gilescope@gmail.com>
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.
This PR makes improvements to the Template pallet's documentation. This is one of the most common pallets anyone starting with FRAME runtime development sees (it's the upstream source of truth for the Substrate node template).
Exceptionally, it does not follow the Documentation guidelines as it services a different audience than developers looking to understand how to use the pallet. Therefore I omitted an "Examples" section in favour of a description of each pallet section with links to the Substrate docs hub.
It also adds a lot more comments and documentation throughout the pallet code.