Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add troubleshooting section #620

Merged
merged 10 commits into from
Apr 4, 2024

Conversation

gmuloc
Copy link
Collaborator

@gmuloc gmuloc commented Apr 3, 2024

Description

Add troubleshooting section to doc

Fixes request from Field

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have run pre-commit for code linting and typing (pre-commit run)
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes (tox -e testenv)

@mtache
Copy link
Collaborator

mtache commented Apr 4, 2024

The ANTA code does not set any default timeout but in one place: the ANTA CLI. This was done to avoid to maintain different default timeout values in the code.
The AntaDevice class is instantiated with timeout=None by default. Which will disable timeout in httpx, not using the 5 sec default: https://www.python-httpx.org/advanced/timeouts/.

The default timeout value when using ANTA CLI is 30 sec. The 10 sec in docstring is outdated (default value in AntaDevice constructor has changed from 10sec to None).

@gmuloc gmuloc marked this pull request as ready for review April 4, 2024 10:32
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
@mtache mtache merged commit 8fd74a9 into arista-netdevops-community:main Apr 4, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants