Did all the nitpicks required

Coderabbit suggestion

Signed-off-by: Shahm Najeeb <Nirt_12023@outlook.com>

Author: DefinetlyNotAI

CODE/Logicytics.py

@@ -137,12 +137,9 @@ def handle_special_actions():
 
     # Deprecated, remove in v3.3.0
     if ACTION == "extra":
-        print("\033[91mDeprecationWarning: "
-              "A call to the deprecated feature `extra` has been called, "
-              "this feature has been removed as it doesn't follow "
-              "the required code standards or aim of Logicytics.\033[0m")
-        log.info("No flag is supplied due to --extra flag deprecation, will show help menu instead")
-        Flag.show_help_menu()
+        print("\033[91mDeprecationWarning: The `extra` feature has been removed! 🚫\n"
+              "Why? It didn't match our code quality standards.\n"
+              "What to use instead? Check out our new features with --help\033[0m")
         input("Press Enter to exit...")
         exit(0)
 
@@ -178,12 +175,9 @@ def handle_special_actions():
 
     # Deprecated, remove in v3.3.0
     if ACTION == "unzip_extra":
-        print("\033[91mDeprecationWarning: "
-              "A call to the deprecated feature `unzip-extra` has been called, "
-              "this feature has been removed as it doesn't follow "
-              "the required code standards or aim of Logicytics.\033[0m")
-        log.info("No flag is supplied due to --unzip-extra flag deprecation, will show help menu instead")
-        Flag.show_help_menu()
+        print("\033[91mDeprecationWarning: The `unzip_extra` feature has been removed! 🚫\n"
+              "Why? It didn't match our code quality standards.\n"
+              "What to use instead? Check out our new features with --help\033[0m")
         input("Press Enter to exit...")
         exit(0)
 

CODE/VulnScan/README.md

@@ -1,10 +1,15 @@
 # VulnScan Documentation
 
 > [!WARNING]
-> VulnScan will be moved to a different repository soon.
-> This part of the repository will be archived and the new repository will be linked here.
-> The `pkl` and `pth` files will stay here, linked properly for `vulnscan.py`,
-> VulnScan will NOT be moved to the other repository.
+> # VulnScan Migration Notice 🚨
+>
+> VulnScan is moving to a new home! Here's what you need to know:
+> - This repository section will be archived
+> - A link to the new repository will be added here
+> - The `pkl` and `pth` files will stay here (they'll work with `vulnscan.py`)
+> - VulnScan itself will NOT be moved to the other repository
+>
+> This will occur in version `3.2.0` of Logicytics.
 
 ## Overview
 

CODE/VulnScan/v3/_generate_data.py

@@ -187,7 +187,10 @@ def generate_file_content(extensions: str) -> tuple[str, str]:
 
     if CODE_NAME == 'SenseMacro':
         print(
-            "\033[91mDeprecationWarning: A call to the deprecated feature SenseMacro has been called, this has been removed due to instability issues, going with default settings (Model Sense).\033[0m")
+            "\033[91mDeprecationWarning: SenseMacro has been removed due to instability issues. "
+            "Please use 'Sense' instead for better stability and performance. "
+            "Defaulting to 'Sense' settings for now.\033[0m"
+        )
         CODE_NAME = 'Sense'
 
     if CODE_NAME == 'Sense':

CODE/logicytics/Flag.py

@@ -172,16 +172,13 @@ def __available_arguments(cls) -> tuple[argparse.Namespace, argparse.ArgumentPar
         parser.add_argument(
             "--unzip-extra",
             action="store_true",
-            help="Unzip the extra directory zip File "
-                 f"{cls.colorify('- Use on your own device only -', 'y')}.",
+            help=f"{cls.colorify('[REMOVED]', 'r')} Unzip the extra directory zip File "
         )
 
         parser.add_argument(
             "--extra",
             action="store_true",
-            help="Open's the extra directory menu to use more tools. "
-                 f"{cls.colorify('- Still experimental -', 'y')} "
-                 f"{cls.colorify('- MUST have used --unzip-extra flag -', 'b')}.",
+            help=f"{cls.colorify('[REMOVED]', 'r')} Open's the extra directory menu to use more tools. "
         )
 
         return parser.parse_args(), parser
@@ -276,9 +273,15 @@ def data(cls) -> ArgumentParser | tuple[str]:
         return tuple(used_flags)
 
     @staticmethod
-    def show_help_menu():
+    def show_help_menu(format_output: bool = False):
         """
         Displays the help menu for the Logicytics application.
+
+        Args:
+             format_output (bool): If True, returns the help text instead of printing it
         """
         _, parser = Flag.__available_arguments()
-        parser.print_help()
+        if format_output:
+            return parser.format_help()
+        else:
+            parser.print_help()

README.md

@@ -32,16 +32,16 @@ To install and setup Logicytics, follow these steps:
 
 2. **Install Dependencies**: Logicytics requires Python modules. You can install all the required modules by running the following command in your terminal:     `pip install -r requirements.txt`
 
-
 3. **Run Logicytics**: To run Logicytics, simply run the following command in your terminal: `python Logicytics.py -h` - This opens a help menu.
 
 > [!IMPORTANT]
 > We recommend Python Version `3.11` or higher, as the project is developed and tested on this version.
 > 
 > You must also install `pytorch` if you want to use the vulnscan feature, To install run the command `pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu124`
-> If the device has CUDA available (NVidea GPU's),
+> If the device has CUDA available (NVidea GPUs),
 >
-> Otherwise run `pip3 install torch torchvision torchaudio` to use the CPU, ofcourse this is optional for normal usage's,
+> Otherwise, run `pip3 install torch torchvision torchaudio` to use the CPU, ofcourse this is optional for normal
+> usage's,
 > until you require `vulnscan`
 
 ### Prerequisites
@@ -124,9 +124,7 @@ It is also used to store and save settings for other programs.
 > this is used to later check for corruption or bugs.
 > VERSION is the version of the project, used to check and pull for updates.
 
-## 🚀 Advanced Usage 🚀
-
-### Mods
+## 🚀 Mods 🚀
 
 Mods are special files that are run with the `--modded` flag.
 These files are essentially scripts that are run after the main Logicytics.py script is run
@@ -178,19 +176,19 @@ If those don't work attempt:
 
 Check out the [wiki](https://github.com/DefinetlyNotAI/Logicytics/wiki) for help.
 
-## 📊 Data Analysis 📊
-
-## Data Extraction
+## 📊 Data Extraction 📊
 
 Logicytics extracts a wide range of data points on a Windows system.
 
 Here are some of the data points that Logicytics extracts:
 
 > [!IMPORTANT]
-> Don't recreate the scripts/ideas below as then it's a waste of time for you, unless the Side-note on the script says otherwise, you can however contribute to the script itself.
+> Don't recreate the scripts/ideas below as then it's a waste of time for you,
+> unless the Side-note on the script says otherwise, you can however contribute to the script itself.
 
 > [!TIP]
-> You can check out future plans [here](PLANS.md), you can contribute these plans if you have no idea's on what to contribute!
+> You can check out future plans [here](PLANS.md),
+> you can contribute these plans if you have no idea's on what to contribute!
 
 | File Name                | About                                                                                                                | Important Note           |
 |--------------------------|----------------------------------------------------------------------------------------------------------------------|--------------------------|
@@ -220,7 +218,8 @@ This is not an exhaustive list,
 but it should give you a good idea of what data Logicytics is capable of extracting.
 
 > [!NOTE]
-> **Any file with `_` is not counted here, do note they may range from custom libraries to special files/wrappers**
+> **Any file with `_` is not counted here,
+> do note they may range from custom libraries to special files/wrappers**
 
 ### Want to create your own mod?
 
@@ -231,13 +230,12 @@ Check out the [contributing guidlines](CONTRIBUTING.md) file for more info
 If there is a specific piece of data that you would like to see extracted by Logicytics,
 please let us know. We are constantly working to improve the project and adding new features.
 
-Other than mods, some prefixed tools are in the `EXTRA` directory, 
-use the `--extra` flag to traverse these special tools
-
 ### Want to create your own mod?
 
-Check out the [contributing guidlines](CONTRIBUTING.md) file for more info, as well as the [wiki guidelines](https://github.com/DefinetlyNotAI/Logicytics/wiki/5-How-to-Contribute) for more info
-Tips and tricks of the given modules/API's can be found [here](https://github.com/DefinetlyNotAI/Logicytics/wiki/6-Code-tips-and-tricks) too!
+Check out the [contributing guidlines](CONTRIBUTING.md) file for more info,
+as well as the [wiki guidelines](https://github.com/DefinetlyNotAI/Logicytics/wiki/5-How-to-Contribute) for more info
+Tips and tricks of the given modules/APIs can be
+found [here](https://github.com/DefinetlyNotAI/Logicytics/wiki/6-Code-tips-and-tricks) too!
 
 > [!IMPORTANT]
 > Always adhere to the [coding standards](https://github.com/DefinetlyNotAI/Logicytics/wiki/7-Advanced-Coding-Standards) of Logicytics!