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

[FEATURE] Documentation #208

Open
1 task done
bconn98 opened this issue Jan 30, 2024 · 3 comments
Open
1 task done

[FEATURE] Documentation #208

bconn98 opened this issue Jan 30, 2024 · 3 comments

Comments

@bconn98
Copy link

bconn98 commented Jan 30, 2024

Is there an existing feature request for this?

  • I have searched the existing feature requests

Is your feature request related to a problem? Please describe.

No where in the README (the only documentation I can find), does it say that the fields of the structs need to be public. That's a basic and easy concept to add to the documentation.

Describe the solution that you would like.

Documentation on using the tools

Describe alternatives you have considered.

No response

Anything else?

No response

@AlexVulaj
Copy link
Member

Hey @bconn98 , thanks for bringing this up - it's a good suggestion. Would you mind opening up a pull request with what you had in mind and linking it to this issue?

@bconn98
Copy link
Author

bconn98 commented Feb 29, 2024

It'll take me a bit to get to, but will do.

@jaitaiwan
Copy link

I think that it is implicit in how Go works. I understand that for folks new to Go it might not be obvious — but there's no way for an ext library (except maybe reflect but haven't looked into that) to see the private fields of a struct. I'm okay with it being documented, I don't think it can hurt... Just noting I don't think it's strictly necessary.

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

No branches or pull requests

3 participants