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

Improve doc comments to be more useful #2098

Open
Jonny1987 opened this issue Feb 9, 2025 · 0 comments
Open

Improve doc comments to be more useful #2098

Jonny1987 opened this issue Feb 9, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Jonny1987
Copy link

The doc comments, which appear when hovering over an object in VSCode are not useful at all. It would be nice if they gave more information such as what exactly it is used for to make coding quicker without needing to search online.

For example, hovering over the silent parameter in the Message class just says: "If true the message is silent"
@xsahil03x xsahil03x added the documentation Improvements or additions to documentation label Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Jonny1987 @xsahil03x