Merge pull request #3185 from tnull/2024-07-clarify-max-description-l…

…ength Clarify maximum length of an invoice description
lightningdevkit · Jul 16, 2024 · dee3ba7 · dee3ba7
2 parents 6e73c37 + fa7ecc5
commit dee3ba7
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lightning-invoice/src/lib.rs b/lightning-invoice/src/lib.rs
@@ -1510,8 +1510,8 @@ impl TaggedField {
 
 impl Description {
 
-	/// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
-	/// returns [`CreationError::DescriptionTooLong`] otherwise
+	/// Creates a new `Description` if `description` is at most 1023 * 5 bits (i.e., 639 bytes)
+	/// long, and returns [`CreationError::DescriptionTooLong`] otherwise.
 	///
 	/// Please note that single characters may use more than one byte due to UTF8 encoding.
 	pub fn new(description: String) -> Result<Description, CreationError> {