[Doc] Updated comment to better reflect behavior of

blank_with_kernel_features #564
This commit is contained in:
Jakob 2021-03-27 11:12:22 +01:00
parent 08bd462a99
commit a896b19575

View file

@ -258,7 +258,7 @@ impl Slate {
/// Create a new slate with custom kernel_feature and lock height /// Create a new slate with custom kernel_feature and lock height
/// If a lock_height is set kernel_features will have to be either HeightLocked (2) or NoRecentDuplicate (3) /// If a lock_height is set kernel_features will have to be either HeightLocked (2) or NoRecentDuplicate (3)
/// otherwise the value passed as lock_height will be ignored and a plain kernel will be created /// otherwise the value passed as lock_height will be ignored and a plain kernel will be created
/// Invalid arguments for kernel_features (>3) will be set to 0 (Plain) /// Invalid arguments for kernel_features (>3) are not allowed and will make the function panic
pub fn blank_with_kernel_features( pub fn blank_with_kernel_features(
num_participants: u8, num_participants: u8,
is_invoice: bool, is_invoice: bool,