Expand docstring for collisions command

The meaning of mods prefixed with 'x' or '*' was previously not indicated anywhere. It is now indicated in the docstring of the collisions command.
cyberrumor · Sep 27, 2024 · 15e9ed7 · 15e9ed7
1 parent ee92aa8
commit 15e9ed7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,9 @@ activate   : (mod|plugin) <index>             : Enabled components will be loade
            :                                  : - `activate plugin 1`
            :                                  : - `activate plugin all`
 ................................................................................................
-collisions : <index>                          : Show file conflicts for a mod.
+collisions : <index>                          : Show file conflicts for a mod. Mods prefixed
+           :                                  : with asterisks have file conflicts. Mods
+           :                                  : prefixed with x install no files.
            :                                  : - `collisions 0`
 ................................................................................................
 commit     :                                  : Apply pending changes.

diff --git a/ammo/mod_controller.py b/ammo/mod_controller.py
@@ -1034,7 +1034,8 @@ def refresh(self) -> None:
 
     def collisions(self, index: int) -> None:
         """
-        Show file conflicts for a mod.
+        Show file conflicts for a mod. Mods prefixed with asterisks
+        have file conflicts. Mods prefixed with x install no files.
         """
         try:
             subject = self.mods[index]