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

Docstring support #48

Closed
ShovanSarker opened this issue May 18, 2023 · 1 comment
Closed

Docstring support #48

ShovanSarker opened this issue May 18, 2023 · 1 comment
Labels
duplicate This issue or pull request already exists

Comments

@ShovanSarker
Copy link

I have a feature request for this project that I would like to propose. I think, the addition of this feature would greatly enhance the project's functionality and usability.

Description

The proposed feature is to incorporate a standardized function, such as doc, that enables retrieving the docstrings for classes and methods and seamlessly inserting them into the UML diagram. This addition would significantly contribute to clarifying the purpose and functionality of classes within the UML representation. It would provide developers with a convenient and consistent way to access the documentation, resulting in improved understanding and maintainability.

Previous Status

Furthermore, I am unsure whether this feature has been requested previously. If it has, I kindly request information regarding its current status or any ongoing efforts to implement it.

@lucsorel lucsorel added enhancement New feature or request help wanted Extra attention is needed and removed enhancement New feature or request help wanted Extra attention is needed labels May 22, 2023
@lucsorel
Copy link
Owner

Duplicate of #34.

Thank you for posting feature requests, but please check beforehand whether a similar issue already exists. There are only 10 open issues, it is easy to check 😃

You can contribute on #34 to suggest how the docstring of a module and a data structure (class, enum, dataclass, etc.) should appear in the generated PlantUML documentation (see #34 (comment)), that would help implementing something satisfying. Thanks 🙏

@lucsorel lucsorel added the duplicate This issue or pull request already exists label May 22, 2023
@lucsorel lucsorel closed this as not planned Won't fix, can't repro, duplicate, stale May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

2 participants