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: create ANTA UML Class Diagram #1004

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Conversation

mtache
Copy link
Collaborator

@mtache mtache commented Jan 13, 2025

Description

Created with pyreverse anta -o mmd --output-directory . --ignore tests,input_models,reporter,cli,constants.py,custom_types.py,decorators.py,logger.py,tools.py,exceptions.py --project anta, then manual editing.

Pink represents pydantic models.

Class Diagram

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)
  • Create a documentation page

Copy link
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

Copy link

codspeed-hq bot commented Jan 14, 2025

CodSpeed Performance Report

Merging #1004 will not alter performance

Comparing mtache:uml (b6ab3e5) with main (d57b53e)

Summary

✅ 22 untouched benchmarks

Copy link
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

Copy link
Collaborator

@gmuloc gmuloc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the great doc! couple of small comments

mkdocs.yml Outdated Show resolved Hide resolved
docs/api/commands.md Show resolved Hide resolved
docs/api/result.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants