chore(docs): menambahkan komentar kode (#90)

Signed-off-by: slowy07 <[email protected]>

OpenSeries/bilangan_istimewa.py

@@ -108,8 +108,10 @@ def angka_segitiga(angka: int) -> Union[int, error.ErrorTipeData, error.Error]:
         error.Error: jika angka negatif
         error.ErrorTipeData: jika tipe data salah
     """
+    # jika tipe data dari angka tidak integer
     if not isinstance(angka, int):
         return error.ErrorTipeData(["int"])
+    # jika value dari angka diisi nilai negatif
     if angka < 0:
         return error.Error("angka tidak boleh negatif")
     return angka * (angka + 1) // 2

OpenSeries/matematika.py

@@ -243,6 +243,7 @@ def permutasi(nilai: int, r: int) -> Union[int, float, error.ErrorTipeData]:
         faktorial_nilai = faktorial(nilai)
         faktorial_nilai_r = faktorial(nilai - r)
 
+        # mengecek tipe data dari nilai faktorial
         if isinstance(faktorial_nilai, int) and isinstance(faktorial_nilai_r, int):
             return faktorial_nilai / faktorial_nilai_r
         else:
@@ -268,6 +269,7 @@ def kombinasi(nilai: int, r: int) -> Union[int, float, error.ErrorTipeData]:
         faktorial_r = faktorial(r)
         faktorial_nilai_r = faktorial(nilai - r)
 
+        # mengecek nilai dari faktorial nilai
         if (
             isinstance(faktorial_nilai, int)
             and isinstance(faktorial_r, int)

OpenSeries/statistika.py

@@ -18,10 +18,13 @@ def entropy(
         error.ErrorTipeData: error jika tipe data salah
         error.Error: jika nilai label yang diberikan kosong
     """
+    # jika tipe data dari label bukan list
     if not isinstance(label, (list)):
         return error.ErrorTipeData(["list"])
+    # jika nilai di dalam list kosong
     if not label:
         return error.Error("label tidak boleh kosong")
+    # jika nilai di dalam list itu tidak int
     if not all(isinstance(cek_nilai, int) for cek_nilai in label):
         return error.ErrorTipeData(["int"])
     _, count = np.unique(label, return_counts=True)
@@ -46,8 +49,10 @@ def standar_deviasi(
         error.ErrorTipeData: error jika tipe data salah
         error.Error: jika vektor yang diberikan kosong
     """
+    # cek parameter vektor jika tidak bertipe data np.ndarray
     if not isinstance(vektor, np.ndarray):
         return error.ErrorTipeData(["numpy array"])
+    # cek jika nilai vektor adalah 0
     if len(vektor) == 0:
         return error.Error("vektor tidak boleh kosong")
 

OpenSeries/util/constant.py

@@ -8,14 +8,9 @@
 # dan dikarakterisasi dalam berbagai cara
 BILANGAN_EULER: float = 2.718281828459045235360
 
-# konstanta plank, yang dilambangankan dengan h, yang merupakan konstanta fisika
-# fundamental yang menghubungkan energi foton dengan frekuensinya, nilainya disini
-# adalah 6.6261 × 10⁻³⁴ (joule per detik)
-KONSTANTA_PLANCK = 6.6261 * pow(10, -34)
-
 # variable ini juga mewakili dari konstanta planck, tetapi dinyatan dalam satuan
 # elektron volt per detik (eV/s) nilainya adalah 4.1357 × 10⁻¹⁵ eV s⁻¹
-KONSTANTA_PLANCK = 4.1357 * pow(10, -15)
+KONSTANTA_PLANCK: float = 4.1357 * pow(10, -15)
 
 # default error dari warna menggunakan kode ANSI escape
 # merah

setup.py

@@ -14,6 +14,7 @@
     if platform.system == "windows":
         core_require.append("pywin32")
 
+
 install_require = [x.strip() for x in core_require if "git+" not in x]
 
 # setup nama project