Skip to content

Automatic class diagram construction#66

Draft
emmuhamm wants to merge 3 commits intodevelopfrom
emmuhamm/auto-class
Draft

Automatic class diagram construction#66
emmuhamm wants to merge 3 commits intodevelopfrom
emmuhamm/auto-class

Conversation

@emmuhamm
Copy link
Copy Markdown
Collaborator

@emmuhamm emmuhamm commented Mar 26, 2026

Description

Fixes #57

WIP

python style_pyreverse.py daqpytools --output-directory pics
python split_diagram.py pics/classes_styled.dot --output-directory pics/split

Make the above a callable script! And everyone will be happy

Make it possible to define your own stylistic yaml file or whatever and pass that in the python script

Maybe this should be a new folder in daqpytools called either docs or UML or whatever

If full description and testing details are included on a parent issue, please link to that here.
See issue # for details

Otherwise, please include a summary of the change and which issue is fixed (if any).
Include relevant motivation and context, including a target environment and dunedaq version if known.
Also list any dependencies that are required for this change.

Addresses issue #

Please also include instructions for how a reviewer can test your changes.

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature or enhancement (non-breaking change which adds functionality)
  • Optimization (non-breaking change that improves code/performance)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Testing checklist

  • Unit tests pass (e.g. dbt-build --unittest)
  • Minimal system quicktest passes (pytest -s minimal_system_quick_test.py)
  • Full set of integration tests pass (dunedaq_integtest_bundle.sh)
  • Python tests pass if applicable (e.g. python -m pytest)
  • Pre-commit hooks run successfully if applicable (e.g. pre-commit run --all-files)

Comments here on the testing

Further checks

  • Code is commented where needed, particularly in hard-to-understand areas
  • Code style is correct (dbt-build --lint, and/or see https://dune-daq-sw.readthedocs.io/en/latest/packages/styleguide/)
  • If applicable, new tests have been added or an issue has been opened to tackle that in the future.
    (Indicate issue here: # (issue))

@emmuhamm emmuhamm self-assigned this Mar 26, 2026
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.

[Doc]: Automatic documentation construction

2 participants