Pre-commit checks

Author: maryamziaa

com.unity.ml-agents/Documentation~/Background.md

@@ -1,6 +1,6 @@
 # Background
 
-This section provides foundational knowledge to help you understand the technologies and concepts that power the ML-Agents Toolkit. 
+This section provides foundational knowledge to help you understand the technologies and concepts that power the ML-Agents Toolkit.
 
 | **Topic**                                          | **Description**                                                               |
 |----------------------------------------------------|-------------------------------------------------------------------------------|

com.unity.ml-agents/Documentation~/Package-Limitations.md

@@ -15,6 +15,6 @@ You can control the frequency of Academy stepping by calling `Academy.Instance.D
 
 ### Input System Integration
 
-For `InputActuatorComponent` (see [Input System Integration](InputSystem-Integration.md) for more information): 
+For `InputActuatorComponent` (see [Input System Integration](InputSystem-Integration.md) for more information):
 - Limited implementation of `InputControls`
 - No way to customize the action space of the `InputActuatorComponent`

com.unity.ml-agents/Documentation~/Readme.md

@@ -41,8 +41,8 @@ developer communities.
 - Wrap Unity learning environments as a [PettingZoo](Python-PettingZoo-API.md) environment
 
 ## Releases & Documentation
- 
-> **⚠️ Documentation Migration Notice**  
+
+> **⚠️ Documentation Migration Notice**
 > We have moved to [Unity Package documentation](https://docs.unity3d.com/Packages/com.unity.ml-agents@latest) as the **primary developer documentation** and have **deprecated** the maintenance of [web docs](https://unity-technologies.github.io/ml-agents/). Please use the Unity Package documentation for the most up-to-date information.
 
 The table below shows our latest release, including our `develop` branch which is
@@ -57,9 +57,9 @@ under active development and may be unstable. A few helpful guidelines:
 - The `com.unity.ml-agents` package is [verified](https://docs.unity3d.com/2020.1/Documentation/Manual/pack-safe.html)
   for Unity 2020.1 and later. Verified packages releases are numbered 1.0.x.
 
-|        **Version**         | **Release Date** | **Source** |                                                **Documentation**                                                 | **Download** | **Python Package** | **Unity Package** |
-|:--------------------------:|:------:|:-------------:|:----------------------------------------------------------------------------------------------------------------:|:------------:|:------------:|:------------:|
-| **Release 22** | **October 5, 2024** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_22)** |                           **[docs](https://unity-technologies.github.io/ml-agents/)**                            | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_22.zip)** | **[1.1.0](https://pypi.org/project/mlagents/1.1.0/)** | **[3.0.0](https://docs.unity3d.com/Packages/[email protected]/manual/index.html)** |
+| **Version** | **Release Date** | **Source** | **Documentation** | **Download** | **Python Package** | **Unity Package** |
+|:-----------:|:---------------:|:----------:|:-----------------:|:------------:|:------------------:|:-----------------:|
+| **Release 22** | **October 5, 2024** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_22)** | **[docs](https://unity-technologies.github.io/ml-agents/)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_22.zip)** | **[1.1.0](https://pypi.org/project/mlagents/1.1.0/)** | **[3.0.0](https://docs.unity3d.com/Packages/[email protected]/manual/index.html)** |
 | **develop (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/develop) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/develop/com.unity.ml-agents/Documentation~/index.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/develop.zip) | -- | -- |
 
 

com.unity.ml-agents/Documentation~/Training.md

@@ -1,4 +1,4 @@
-Use the following topics to learn about training in ML-Agents. 
+Use the following topics to learn about training in ML-Agents.
 
 
 | **Section**                                                   | **Description**                        |

com.unity.ml-agents/Documentation~/index.md

@@ -29,7 +29,7 @@ The package allows you to convert any Unity scene into a learning environment an
 * Define Behaviors: entities that specify how an agent should act. Multiple agents can share the same Behavior and a scene may have multiple Behaviors.
 * Record demonstrations: To show the behaviors of an agent within the Editor. You can use demonstrations to help train a behavior for that agent.
 * Embed a trained behavior (aka: run your ML model) in the scene via the [Inference Engine](https://docs.unity3d.com/Packages/com.unity.ai.inference@latest). Embedded behaviors allow you to switch an Agent between learning and inference.
-* 
+
 ## Community and Feedback (review needed)
 
 The ML-Agents Toolkit is an open-source project, and we encourage and welcome

utils/make_readme_table.py

@@ -96,13 +96,16 @@ def doc_link(self):
         if self.is_verified:
             return "https://github.com/Unity-Technologies/ml-agents/blob/release_2_verified_docs/docs/Readme.md"
 
-        if self.csharp_version == 'develop':
-            return "https://github.com/Unity-Technologies/ml-agents/tree/develop/com.unity.ml-agents/Documentation~/index.md"
+        if self.csharp_version == "develop":
+            return (
+                "https://github.com/Unity-Technologies/ml-agents/tree/"
+                "develop/com.unity.ml-agents/Documentation~/index.md"
+            )
 
         # Prioritize Unity Package documentation over web docs
         try:
-            v = StrictVersion(self.csharp_version).version
-            return f"https://docs.unity3d.com/Packages/com.unity.ml-agents@latest"
+            StrictVersion(self.csharp_version).version
+            return "https://docs.unity3d.com/Packages/com.unity.ml-agents@latest"
         except ValueError:
             # Fallback to deprecated web docs with warning
             return "https://unity-technologies.github.io/ml-agents/ (DEPRECATED)"