💡 Add Comments to Exported Functions

Author: UltiRequiem

LICENSE.md

@@ -2,20 +2,19 @@
 
 Copyright (c) 2021 Eliaz Bobadilla
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -5,13 +5,17 @@
 ![Lines Of Code](https://img.shields.io/tokei/lines/github.com/UltiRequiem/fibonacci-deno?color=blue&label=Total%20Lines)
 ![CodeQL](https://github.com/UltiRequiem/fibonacci-deno/workflows/CodeQL/badge.svg)
 
-Port of [fibonacci-go](https://github.com/UltiRequiem/fibonacci) for [Deno](https://deno.land).
+Port of [fibonacci-go](https://github.com/UltiRequiem/fibonacci) for
+[Deno](https://deno.land).
 
 > Utilities for the Fibonacci Number and Sequence
 
 ## Usage
 
-This package exposes two Functions, [fibonacci](https://github.com/UltiRequiem/fibonacci-deno/blob/main/mod.ts#L1) and [fibonacciSequence](https://github.com/UltiRequiem/fibonacci-deno/blob/main/mod.ts#L15).
+This package exposes two Functions,
+[fibonacci](https://github.com/UltiRequiem/fibonacci-deno/blob/main/mod.ts#L1)
+and
+[fibonacciSequence](https://github.com/UltiRequiem/fibonacci-deno/blob/main/mod.ts#L15).
 
 ```typescript
 import {
@@ -63,4 +67,5 @@ $ fibonacci --number 3
 
 ### License
 
-[This package](https://deno.land/x/fibonacci) is licensed under the [MIT License](./LICENSE.md).
+[This package](https://deno.land/x/fibonacci) is licensed under the
+[MIT License](./LICENSE.md).

mod.ts

@@ -1,4 +1,9 @@
-export function fibonacci(n: number) {
+/**
+ * Returns the Nth Fibonacci Number
+ * @param n The Nth Fibonacci Number you want to get
+ * @returns The Nth Fibonacci Number
+ */
+export function fibonacci(n: number): number {
   if (n < 0) {
     throw new Error(`Expected a number bigger than zero, but got ${n}.`);
   }
@@ -12,7 +17,12 @@ export function fibonacci(n: number) {
 
 fibonacci.cache = [0, 1, 1];
 
-export function fibonacciSequence(length: number) {
+/**
+ * Return an Array with the first N numbers of the Fibonacci Sequence
+ * @param  length The length of the array you want to get
+ * @returns The Array with the first N numbers of the Fibonacci Sequence
+ */
+export function fibonacciSequence(length: number): number[] {
   const sequence = [];
 
   for (let i = 0; i < length; i++) {