edit: docs; package.json run commands

.github/workflows/deploy-docs.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
         run: |
           npm i
-          npm run docs
+          npm run docs:build
 
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@v4

README.md

@@ -7,4 +7,5 @@ npm i @gkucmierz/utils
 
 ### Docs
 
-https://gkucmierz.github.io/utils
+[https://gkucmierz.github.io/utils](https://gkucmierz.github.io/utils)
+

package.json

@@ -7,7 +7,9 @@
     "test": "jasmine",
     "watch": "nodemon --exec 'npm test'",
     "main": "node scripts/generate_main.mjs",
-    "docs": "jsdoc -c jsdoc.json"
+    "docs": "npm run docs:build; npm run docs:open",
+    "docs:build": "jsdoc -c jsdoc.json --readme README.md",
+    "docs:open": "open docs/index.html"
   },
   "repository": {
     "type": "git",

src/square-root.mjs

@@ -2,14 +2,16 @@
 
 /**
  * Native square root
- * @param {Number} js double number
+ * @function
+ * @param {Number} number - js double number
  * @return {Number} result
  */
 export const squareRoot = n => n ** 0.5;
 
 /**
  * Calculate square root using Newton's formula
- * @param {BigInt} big integer number
+ * @function
+ * @param {BigInt} number - big integer number
  * @return {BigInt} result
  */
 export const squareRootBI = n => {