Update guide

aristanetworks · Jan 19, 2025 · f2def95 · f2def95
1 parent e72842b
commit f2def95
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 19 deletions.
diff --git a/anta/runner.py b/anta/runner.py
@@ -10,6 +10,8 @@
 from collections import defaultdict
 from typing import TYPE_CHECKING, Any
 
+from typing_extensions import deprecated
+
 from anta import GITHUB_SUGGESTION
 from anta._runner import AntaRunner, AntaRunnerScope
 from anta.logger import anta_log_exception, exc_to_str
@@ -29,6 +31,7 @@
 
     DEFAULT_NOFILE = 16384
 
+    @deprecated("This function is deprecated and will be removed in ANTA v2.0.0.")
     def adjust_rlimit_nofile() -> tuple[int, int]:
         """Adjust the maximum number of open file descriptors for the ANTA process.
 

diff --git a/docs/advanced_usages/scaling.md b/docs/advanced_usages/scaling.md
@@ -196,22 +196,26 @@ Remember to:
 
 # 📚 Additional Documentation
 
-- **Python AsyncIO**
-  - [AsyncIO Documentation](https://docs.python.org/3/library/asyncio.html)
-  - [AsyncIO Event Loop](https://docs.python.org/3/library/asyncio-eventloop.html)
-  - [AsyncIO Tasks and Coroutines](https://docs.python.org/3/library/asyncio-task.html)
-
-- **HTTPX**
-  - [HTTPX Documentation](https://www.python-httpx.org/)
-  - [Timeouts](https://www.python-httpx.org/advanced/timeouts/)
-  - [Resource Limits](https://www.python-httpx.org/advanced/resource-limits/)
-
-- **GNU Parallel**
-  - [GNU Parallel Documentation](https://www.gnu.org/software/parallel/)
-  - [GNU Parallel Tutorial](https://www.gnu.org/software/parallel/parallel_tutorial.html)
-
-- **JSON and YAML Processing**
-  - [jq Manual](https://jqlang.github.io/jq/manual/)
-  - [jq GitHub Repository](https://github.com/jqlang/jq)
-  - [yq Documentation](https://mikefarah.gitbook.io/yq/)
-  - [yq GitHub Repository](https://github.com/mikefarah/yq/)
+**Python AsyncIO**:
+
+- [AsyncIO Documentation](https://docs.python.org/3/library/asyncio.html)
+- [AsyncIO Event Loop](https://docs.python.org/3/library/asyncio-eventloop.html)
+- [AsyncIO Tasks and Coroutines](https://docs.python.org/3/library/asyncio-task.html)
+
+**HTTPX**:
+
+- [HTTPX Documentation](https://www.python-httpx.org/)
+- [Timeouts](https://www.python-httpx.org/advanced/timeouts/)
+- [Resource Limits](https://www.python-httpx.org/advanced/resource-limits/)
+
+**GNU Parallel**:
+
+- [GNU Parallel Documentation](https://www.gnu.org/software/parallel/)
+- [GNU Parallel Tutorial](https://www.gnu.org/software/parallel/parallel_tutorial.html)
+
+**JSON and YAML Processing**:
+
+- [jq Manual](https://jqlang.github.io/jq/manual/)
+- [jq GitHub Repository](https://github.com/jqlang/jq)
+- [yq Documentation](https://mikefarah.gitbook.io/yq/)
+- [yq GitHub Repository](https://github.com/mikefarah/yq/)