Doc commit tag conventions

2025-03-10 05:36:16 +00:00
parent 307650e9fc
commit 0346f3f79e
23 changed files with 1290 additions and 286 deletions
@@ -255,6 +255,10 @@ export class PrivateKey {
  /**
   * Sign a message using a recoverable compact signature format.
   *
+   * @remarks
+   *
+   * This method will SHA256 hash the message for you.
+   *
   * @param message The message to sign, either as a Uint8Array or string.
   * If a string is provided, it will be converted to UTF-8 bytes.
   *
@@ -275,6 +279,10 @@ export class PrivateKey {
  /**
   * Sign a message using a compact signature format.
   *
+   * @remarks
+   *
+   * This method will SHA256 hash the message for you.
+   *
   * @param message The message to sign, either as a Uint8Array or string.
   * If a string is provided, it will be converted to UTF-8 bytes.
   *
@@ -295,6 +303,10 @@ export class PrivateKey {
  /**
   * Sign a message using the Schnorr signature scheme.
   *
+   * @remarks
+   *
+   * This method will SHA256 hash the message for you.
+   *
   * @param message The message to sign, either as a Uint8Array or string.
   * If a string is provided, it will be converted to UTF-8 bytes.
   *
@@ -315,6 +327,10 @@ export class PrivateKey {
  /**
   * Sign a message using DER (Distinguished Encoding Rules) format.
   *
+   * @remarks
+   *
+   * This method will SHA256 hash the message for you.
+   *
   * @param message The message to sign, either as a Uint8Array or string.
   * If a string is provided, it will be converted to UTF-8 bytes.
   *