add name Others

NPLinker · Aug 6, 2024 · 4f95f46 · 4f95f46
1 parent 52a69b6
commit 4f95f46
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/nplinker/genomics/bgc.py b/src/nplinker/genomics/bgc.py
@@ -35,7 +35,7 @@ class BGC:
             gives product information.
             For MIBiG metadata, its biosynthetic class provides such info.
         mibig_bgc_class: A tuple of MIBiG biosynthetic classes to which the BGC belongs.
-            Defaults to None.
+            Defaults to None, which means the class is unknown.
 
             MIBiG defines 6 major biosynthetic classes for natural products,
             including `NRP`, `Polyketide`, `RiPP`, `Terpene`, `Saccharide`
@@ -152,6 +152,10 @@ def bigscape_classes(self) -> set[str | None]:
         - Saccharides
         - Terpene
 
+        For BGC falls outside of these categories, the value is "Others".
+
+        Default is None, which means the class is unknown.
+
         More details see:
         https://doi.org/10.1038%2Fs41589-019-0400-9.
         """

diff --git a/src/nplinker/genomics/gcf.py b/src/nplinker/genomics/gcf.py
@@ -32,6 +32,10 @@ class GCF:
             - Saccharides
             - Terpene
 
+            For BGC falls outside of these categories, the value is "Others".
+
+            Default is None, which means the class is unknown.
+
             More details see:
             https://doi.org/10.1038%2Fs41589-019-0400-9.
     """