test optional param jsdoc

cityssm · May 28, 2024 · a034e05 · a034e05
1 parent 4307655
commit a034e05
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/index.ts b/index.ts
@@ -33,7 +33,7 @@ export function getPaperSize(
  * - North American paper sizes in "in".
  * - ISO paper sizes in "mm".
  * @param paperType Paper type.
- * @param paperSizeUnit Optional parameter to return size values in specific unit ("mm" or "in").
+ * @param [paperSizeUnit] Optional parameter to return size values in specific unit ("mm" or "in").
  * @returns The portrait paper specifications.
  */
 export function getPaperSize(
@@ -87,7 +87,7 @@ export function getLandscapePaperSize(
  * - North American paper sizes in "in".
  * - ISO paper sizes in "mm".
  * @param paperType Paper type.
- * @param paperSizeUnit Optional parameter to return size values in specific unit ("mm" or "in").
+ * @param [paperSizeUnit] Optional parameter to return size values in specific unit ("mm" or "in").
  * @returns The landscape paper specifications.
  */
 export function getLandscapePaperSize(
@@ -137,7 +137,7 @@ export function getPaperSizeInMillimetres(
 ): undefined
 
 /**
- * Retrieves the portarit paper dimensions in millimetres.
+ * Retrieves the portrait paper dimensions in millimetres.
  * @param paperType Paper type.
  * @returns The portrait paper specifications in millimetres.
  */