change(pallet-assets): improve documentation

substrate/frame/assets/src/functions.rs

@@ -998,7 +998,11 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
 		})
 	}
 
-	/// Do set sufficiency
+	/// Set the sufficiency of an asset class
+	///
+	/// ### Errors
+	///
+	/// - [`Unknown`][crate::Error::Unknown] when the asset ID is unknown.
 	pub(super) fn do_set_sufficiency(asset_id: T::AssetId, is_sufficient: bool) -> DispatchResult {
 		Asset::<T, I>::try_mutate(asset_id, |maybe_asset| {
 			if let Some(asset) = maybe_asset {

substrate/frame/assets/src/traits.rs

@@ -1,26 +1,18 @@
 pub mod sufficiency {
 	use sp_runtime::DispatchResult;
 
-	/// Trait for providing the sufficient state of an asset.
+	/// Trait for providing the sufficiency of an asset.
 	pub trait Inspect<AssetId> {
 		/// Returns whether an asset is sufficient or not.
 		fn is_sufficient(asset_id: AssetId) -> bool;
 	}
 
-	/// Trait for mutating the sufficient state of an asset
+	/// Trait for mutating the sufficiency of an asset
 	pub trait Mutate<AssetId> {
-		/// Makes the asset to be sufficient.
-		///
-		/// ### Errors
-		///
-		/// - [`Unknown`][crate::Error::Unknown] when the asset ID is unknown.
+		/// Makes the asset sufficient.
 		fn make_sufficient(asset_id: AssetId) -> DispatchResult;
 
-		/// Makes the asset to be insufficient.
-		///
-		/// ### Errors
-		///
-		/// - [`Unknown`][crate::Error::Unknown] when the asset ID is unknown.
+		/// Makes the asset insufficient.
 		fn make_insufficient(asset_id: AssetId) -> DispatchResult;
 	}
 }