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

Help improve package documentation #67

Closed
rjfonseca opened this issue Sep 30, 2020 · 1 comment
Closed

Help improve package documentation #67

rjfonseca opened this issue Sep 30, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed no-issue-activity

Comments

@rjfonseca
Copy link
Member

rjfonseca commented Sep 30, 2020 •
edited
Loading

If you would like to help out and at the same time get acquainted with the project, please feel free update our documentation (using the godoc format) to be more clear and/or add more examples.

A good way to think of it is to ask yourself: Why someone should use this function and write down the answer as a godoc.

https://go.dev/blog/godoc
@rjfonseca rjfonseca added the documentation Improvements or additions to documentation label Sep 30, 2020
@rjfonseca rjfonseca pinned this issue Oct 28, 2022
@rjfonseca rjfonseca added help wanted Extra attention is needed good first issue Good for newcomers labels Oct 28, 2022
@rjfonseca rjfonseca changed the title Improve package documentation Help improve package documentation Oct 28, 2022
@leoeareis leoeareis mentioned this issue Nov 30, 2022
Merged
@github-actions
Copy link

Stale issue message

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 5, 2023
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 good first issue Good for newcomers help wanted Extra attention is needed no-issue-activity
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rjfonseca