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.

Sign up for GitHub

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

Jump to bottom

Finish documenting #[pallet::xxx] macros #2638

Merged
merged 65 commits into from
Mar 3, 2024
Merged

Finish documenting #[pallet::xxx] macros #2638

merged 65 commits into from
Mar 3, 2024

Conversation

liamaharon
Copy link
Member

@liamaharon liamaharon commented Dec 6, 2023 •
edited
Loading

Closes paritytech/polkadot-sdk-docs#35

  • Moves pallet proc macro docs to frame_support
  • Adds missing docs
  • Revise revise existing docs, adding compiling doctests where appropriate

@liamaharon liamaharon added the R0-silent Changes should not be mentioned in any release notes label Dec 6, 2023
@liamaharon
Copy link
Member Author

bot fmt

@command-bot
Copy link

command-bot bot commented Dec 7, 2023 •
edited
Loading

@liamaharon https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/4635579 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 4-47b8d4d0-7302-46c8-aea5-a18c2d06d774 to cancel this command or bot cancel to cancel all commands in this pull request.

@command-bot
Copy link

command-bot bot commented Dec 7, 2023

@liamaharon Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/4635579 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/4635579/artifacts/download.

@liamaharon liamaharon marked this pull request as ready for review December 7, 2023 14:55
@liamaharon liamaharon requested review from a team December 7, 2023 14:55
lexnv
lexnv approved these changes Mar 1, 2024
View reviewed changes
Copy link
Contributor

@lexnv lexnv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job here!

Left some small nits, which could be ignored if not applicable 👍

@liamaharon liamaharon disabled auto-merge March 3, 2024 07:27
@liamaharon liamaharon mentioned this pull request Mar 3, 2024
Closed
@liamaharon liamaharon added this pull request to the merge queue Mar 3, 2024
Merged via the queue into master with commit b0741d4 Mar 3, 2024
127 of 130 checks passed
@liamaharon liamaharon deleted the liam-pallet-macro-docs branch March 3, 2024 09:02
ordian added a commit that referenced this pull request Mar 4, 2024
@ordian
Merge branch 'master' into ao-collator-parent-head-data
8910798 
* master:
  Finish documenting `#[pallet::xxx]` macros  (#2638)
  Remove `as frame_system::DefaultConfig` from the required syntax in `derive_impl` (#3505)
  provisioner: allow multiple cores assigned to the same para (#3233)
  subsystem-bench: add regression tests for availability read and write (#3311)
  make SelfParaId a metadata constant (#3517)
  Fix crash of synced parachain node run with `--sync=warp` (#3523)
  [Backport] Node version and spec_version bumps and ordering of the prdoc files from 1.8.0 (#3508)
  Add `claim_assets` extrinsic to `pallet-xcm` (#3403)
ordian added a commit that referenced this pull request Mar 4, 2024
@ordian
Merge branch 'ao-collator-parent-head-data' into ao-send-parent-head-…
6109444 
…data

* ao-collator-parent-head-data:
  add a comment (review)
  Finish documenting `#[pallet::xxx]` macros  (#2638)
  Remove `as frame_system::DefaultConfig` from the required syntax in `derive_impl` (#3505)
  provisioner: allow multiple cores assigned to the same para (#3233)
  subsystem-bench: add regression tests for availability read and write (#3311)
  make SelfParaId a metadata constant (#3517)
  Fix crash of synced parachain node run with `--sync=warp` (#3523)
  [Backport] Node version and spec_version bumps and ordering of the prdoc files from 1.8.0 (#3508)
  Add `claim_assets` extrinsic to `pallet-xcm` (#3403)
skunert pushed a commit to skunert/polkadot-sdk that referenced this pull request Mar 4, 2024
@liamaharon @kianenigma @skunert
Finish documenting #[pallet::xxx] macros (paritytech#2638)
042b716 
Closes paritytech/polkadot-sdk-docs#35

- Moves pallet proc macro docs to `frame_support`
- Adds missing docs
- Revise revise existing docs, adding compiling doctests where
appropriate

---------

Co-authored-by: command-bot <>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this pull request Mar 25, 2024
@kianenigma @DrW3RK
@skunert @gpestana @liamaharon
Add documentation around FRAME Origin (paritytech#3362)
f6b16f2 
Does the following: 

- Add a reference doc page named `frame_runtime_types`, which explains
what types like `RuntimeOrigin`, `RuntimeCall` etc are.
- On top of it, it adds a reference doc page called `frame_origin` which
explains a few important patterns that we use around origins
- And finally brushes up `#[frame::origin]` docs. 
- Updates the theme, sidebar and favicon to look like: 

<img width="1728" alt="Screenshot 2024-02-20 at 12 16 00"
src="https://github.com/paritytech/polkadot-sdk/assets/5588131/6d60a16b-2081-411b-8869-43b91920cca9">


All of this was inspired by
https://substrate.stackexchange.com/questions/10992/how-do-you-find-the-public-key-for-the-medium-spender-track-origin/10993

closes paritytech/polkadot-sdk-docs#45
closes paritytech/polkadot-sdk-docs#43
contributes / overlaps with
paritytech#2638 cc @liamaharon
deprecation companion:
substrate-developer-hub/substrate-docs#2131
pba-content companion:
Polkadot-Blockchain-Academy/pba-content#977

---------

Co-authored-by: Radha <86818441+DrW3RK@users.noreply.github.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this pull request Mar 25, 2024
@liamaharon @kianenigma
Finish documenting #[pallet::xxx] macros (paritytech#2638)
a73df4d 
Closes paritytech/polkadot-sdk-docs#35

- Moves pallet proc macro docs to `frame_support`
- Adds missing docs
- Revise revise existing docs, adding compiling doctests where
appropriate

---------

Co-authored-by: command-bot <>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
This was referenced Jun 5, 2024
Closed
Closed
Closed
Closed
bkontur added a commit that referenced this pull request Jun 7, 2024
@bkontur
Backport from polkadot-sdk with actual master (#2633) (#2638)
4d3758f 
* Backport from `polkadot-sdk`

* lingua stuff

* Fixes

* Fix

* Features?

* Fix - v5 -> v6

* zepter format features

* try zepter with CI

* Fix imports

* Fix

* Fix

* Fix

* Revert zepther pipeline
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@juangirini juangirini juangirini approved these changes

@kianenigma kianenigma kianenigma approved these changes

@lexnv lexnv lexnv approved these changes

Assignees
No one assigned
Labels
R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document #[pallet::xxx] macros
5 participants
@liamaharon @paritytech-cicd-pr @juangirini @kianenigma @lexnv