Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Add HoldReason to the NIS pallet #13823

Merged
paritytech-processbot merged 4 commits into from
Apr 6, 2023
Merged

Add HoldReason to the NIS pallet #13823

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
857a896
Add HoldReason to the NIS pallet
KiChjang Apr 5, 2023
1e1aa87
Rename composable_enum to composite_enum
KiChjang Apr 5, 2023
cbab7a2
Add encoding test
KiChjang Apr 5, 2023
2ee4a90
Add more doc comments
KiChjang Apr 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add more doc comments
  • Loading branch information
@KiChjang
KiChjang committed Apr 5, 2023
commit 2ee4a9050bbdfc731c5785784db78b24c9c63a7d
1 change: 1 addition & 0 deletions frame/support/procedural/src/construct_runtime/expand/freeze_reason.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ pub fn expand_outer_freeze_reason(pallet_decls: &[Pallet], scrate: &TokenStream)
}

quote! {
/// A reason for placing a freeze on funds.
Copy link
Member

@bkchr bkchr Apr 5, 2023

Choose a reason for hiding this comment

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

I think it would be better to forward the real docs put on top of the type?

Copy link
Contributor Author

@KiChjang KiChjang Apr 5, 2023

Choose a reason for hiding this comment

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

Isn't that what this is already doing? It's documenting a type that is expanded by the proc macro.

Copy link
Member

@bkchr bkchr Apr 5, 2023

Choose a reason for hiding this comment

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

This isn't forwarding the docs that I as a user put onto the type?

Copy link
Contributor Author

@KiChjang KiChjang Apr 6, 2023

Choose a reason for hiding this comment

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

Ah okay, so the problem is that RuntimeFreezeReason is never exposed to the user -- it's generated by construct_runtime. The only way that this would make sense is if we forward the doc comments on the pallet's FreezeReason, which I think is already what we do.

Copy link
Member

@bkchr bkchr Apr 6, 2023

Choose a reason for hiding this comment

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

Ahh okay, missed that this is the runtime level declaration.

#[derive(
Copy, Clone, Eq, PartialEq, Ord, PartialOrd,
#scrate::codec::Encode, #scrate::codec::Decode, #scrate::codec::MaxEncodedLen,
Expand Down
1 change: 1 addition & 0 deletions frame/support/procedural/src/construct_runtime/expand/hold_reason.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ pub fn expand_outer_hold_reason(pallet_decls: &[Pallet], scrate: &TokenStream) -
}

quote! {
/// A reason for placing a hold on funds.
#[derive(
Copy, Clone, Eq, PartialEq, Ord, PartialOrd,
#scrate::codec::Encode, #scrate::codec::Decode, #scrate::codec::MaxEncodedLen,
Expand Down
1 change: 1 addition & 0 deletions frame/support/procedural/src/construct_runtime/expand/lock_id.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ pub fn expand_outer_lock_id(pallet_decls: &[Pallet], scrate: &TokenStream) -> To
}

quote! {
/// An identifier for each lock placed on funds.
#[derive(
Copy, Clone, Eq, PartialEq, Ord, PartialOrd,
#scrate::codec::Encode, #scrate::codec::Decode, #scrate::codec::MaxEncodedLen,
Expand Down
1 change: 1 addition & 0 deletions frame/support/procedural/src/construct_runtime/expand/slash_reason.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ pub fn expand_outer_slash_reason(pallet_decls: &[Pallet], scrate: &TokenStream)
}

quote! {
/// A reason for slashing funds.
#[derive(
Copy, Clone, Eq, PartialEq, Ord, PartialOrd,
#scrate::codec::Encode, #scrate::codec::Decode, #scrate::codec::MaxEncodedLen,
Expand Down