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

Add documentation for pyreverse and symilar #4616

Closed
DudeNr33 opened this issue Jun 27, 2021 · 1 comment · Fixed by #4992
Closed

Add documentation for pyreverse and symilar #4616

DudeNr33 opened this issue Jun 27, 2021 · 1 comment · Fixed by #4992
Labels
Documentation 📗 pyreverse Related to pyreverse component
Milestone

Comments

@DudeNr33
Copy link
Collaborator

DudeNr33 commented Jun 27, 2021

Is your feature request related to a problem? Please describe

pyreverse is an awesome tool to visualize the project structure and dependencies.
However, it is not even mentioned once in the documentation.
I think adding at least some basic instructions on how to use it and what the output looks like would make it a bit more widely known.

Probably symilar should get a few sentences as well, but I must admit that I do not know if it is really intended to be used from the command line directly?

The last console script which gets installed additionally to pylint is epylint. I do not think that it needs additional documentation, since as I understand it its main purpose is the integration with Emacs, which is already described properly in the docs.

Describe the solution you'd like

Add documentation pages for at least pyreverse, probably also symilar.

You can assign this issue directly to me, if you want.

@Pierre-Sassoulas Pierre-Sassoulas added Documentation 📗 pyreverse Related to pyreverse component labels Jun 27, 2021
@Pierre-Sassoulas
Copy link
Member

I agree, we need more documentation (in general too, but for pyreverse in particular). Especially if there is a new fancy plantuml option 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📗 pyreverse Related to pyreverse component
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants