Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vitthalmagadum committed Nov 25, 2024
1 parent ded70e0 commit c58b5f9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 3 additions & 3 deletions anta/input_models/security.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ def __str__(self) -> str:


class IPSecPeers(IPSecPeer): # pragma: no cover
"""Alias for the IPSecPeer model to maintain backward compatibility.
"""Alias for the IPSecPeers model to maintain backward compatibility.
When initialized, it will emit a deprecation warning and call the IPSecPeers model.
When initialized, it will emit a deprecation warning and call the IPSecPeer model.
TODO: Remove this class in ANTA v2.0.0.
"""

def __init__(self, **data: Any) -> None: # noqa: ANN401
"""Initialize the BgpAfi class, emitting a deprecation warning."""
"""Initialize the IPSecPeer class, emitting a deprecation warning."""
warn(
message="IPSecPeers model is deprecated and will be removed in ANTA v2.0.0. Use the IPSecPeer model instead.",
category=DeprecationWarning,
Expand Down
4 changes: 3 additions & 1 deletion docs/api/tests.security.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,6 @@ anta_title: ANTA catalog for security tests
merge_init_into_class: false
anta_hide_test_module_description: true
show_labels: true
filters: ["!^__str__"]
filters:
- "!^__init__"
- "!^__str__"

0 comments on commit c58b5f9

Please sign in to comment.