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

Add documentation comments #89

Open
AleksBekker opened this issue Mar 22, 2024 · 0 comments
Open

Add documentation comments #89

AleksBekker opened this issue Mar 22, 2024 · 0 comments
Assignees
@AleksBekker
Labels
documentation Improvements or additions to documentation

Comments

@AleksBekker
Copy link
Collaborator

As a Developer
I want Code documentation
So that There is increased IDE support for developers working on this project

Request Description
I wish that all widely used structures, traits, types, functions, and other language constructs had doccomments that would explain to the developer exactly what the code does.

Is your feature request related to a problem? Please describe.
I'm frustrated that I have to read code to understand what a pre-defined code construct does.

Additional context
N/A
@AleksBekker AleksBekker added the documentation Improvements or additions to documentation label Mar 22, 2024
@AleksBekker AleksBekker self-assigned this Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AleksBekker AleksBekker

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@AleksBekker