Updated all pallets documentation #484
Open
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
|
@JoshOrndorff Can you please take a look to this PR thnx. |
JoshOrndorff
requested changes
Jun 20, 2022
| @@ -1,5 +1,5 @@ | |||
| //! Service and ServiceFactory implementation. Specialized wrapper over substrate service. | |||
|
|
|||
| #![allow(clippy::needless_borrow)] | |||
There was a problem hiding this comment.
Why do we need this? If it is in our code, we should remove the borrow. If this code comes from a Substrate macro, I'm fine with overriding adding this for now. But we should make an upstream PR to make the macro better. Here's an example of one I've done in the past paritytech/substrate#9053
| @@ -1,86 +1,111 @@ | |||
| #![cfg_attr(not(feature = "std"), no_std)] | |||
| #![allow(clippy::unused_unit)] | |||
Comment on lines
+19
to
+22
| #[pallet::config] | ||
| pub trait Config: frame_system::Config { | ||
| /// The overarching event type. | ||
| type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>; |
There was a problem hiding this comment.
Oh wow, I didn't realize there were pallets actually using the old decl_ macros still. Good catch.
Comment on lines
+60
to
80
| ensure!( | ||
| members.len() < MAX_MEMBERS, | ||
| Error::<T>::MembershipLimitReached | ||
| ); | ||
|
|
||
| // We don't want to add duplicate members, so we check whether the potential new | ||
| // member is already present in the list. Because the list is always ordered, we can | ||
| // leverage the binary search which makes this check O(log n). | ||
| match members.binary_search(&new_member) { | ||
| // If the search succeeds, the caller is already a member, so just return | ||
| Ok(_) => Err(Error::<T>::AlreadyMember.into()), | ||
| // If the search fails, the caller is not a member and we learned the index where | ||
| // they should be inserted | ||
| Err(index) => { | ||
| members.insert(index, new_member.clone()); | ||
| Members::<T>::put(members); | ||
| Self::deposit_event(Event::MemberAdded(new_member)); | ||
| Ok(().into()) | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Is the formatting right here? The syntax highlighting is confusing github. Not sure why though. Maybe this is just fine.
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.
Some time ago all the pallets have been updated from v1 to v2 but the document files were not updated. In this PR I have updated them.
@JoshOrndorff Please take a look and let me know.