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.

Sign up for GitHub

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

Jump to bottom

doc improvement: arrows #7822

Open
ggrrll opened this issue Nov 22, 2022 · 0 comments
Open

doc improvement: arrows #7822

ggrrll opened this issue Nov 22, 2022 · 0 comments
Labels
Documentation 📗 Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation pyreverse Related to pyreverse component

Comments

@ggrrll
Copy link

ggrrll commented Nov 22, 2022

Current problem

currently, it's difficult to people who are new to UML diagrams to understand what is output by pyreverse

Desired solution

it would be nice to have a description in the docs of the arrows meaning

Additional context

for instance , something like
https://paulrumyancev.medium.com/uml-class-diagram-arrows-guide-37e4b1bb11e
@ggrrll ggrrll added the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Nov 22, 2022
@Pierre-Sassoulas Pierre-Sassoulas added Help wanted 🙏 Outside help would be appreciated, good for new contributors Good first issue Friendly and approachable by new contributors Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation and removed Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling labels Nov 22, 2022
@clavedeluna clavedeluna added the pyreverse Related to pyreverse component label Nov 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation 📗 Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation pyreverse Related to pyreverse component
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Pierre-Sassoulas @ggrrll @clavedeluna