google / google/sbsim

UML Diagram

Open
#52 2 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Python
Stars
123
Forks
56
Avg merge
17d 18h
Merged PRs (30d)
3

Description

As a contributor, to help better communicate and understand the connections between all the classes, especially in cases of inheritance, it would be helpful to include a UML or related diagram in the docs.

Ideally we would be able to automatically generate an updated diagram when the code changes.

We can consider using a tool like `pyfactor`:
https://pyfactor.readthedocs.io/en/stable/index.html

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.