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/comments #626

Open
nakamume opened this issue Aug 8, 2022 · 0 comments
Open

Add documentation/comments #626

nakamume opened this issue Aug 8, 2022 · 0 comments
Labels
feature request New feature or request

Comments

@nakamume
Copy link

nakamume commented Aug 8, 2022

Is your feature request related to a problem? Please describe.
None of the exported types, methods or functions seem to have any comments on them. It makes it super difficult to know:

  1. What values to set for a type
  2. Which method or function to call

Ex: specutils has couple of types with lots of fields and lots of methods but with zero comments.

Describe the solution you'd like to see
I love aws-sdk-go. Thanks to the comments, I've never felt any need for documentation.

Describe alternatives you've considered
Currently I'm just googling stuff for what values to set for a type. I've been playing trial-and-error to see if adding/removing a type field results in my desired output.

@nakamume nakamume added the feature request New feature or request label Aug 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant