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

docs: direct users to library API #73

Merged
merged 2 commits into from
Mar 4, 2024
Merged

docs: direct users to library API #73

merged 2 commits into from
Mar 4, 2024

Conversation

bashbunni
Copy link
Member

In an attempt to improve our documentation while keeping the cost of maintenance as low as possible, I think it would be valuable to direct users on how to use the examples provided. A lot of people who are new to Go aren't aware that they can see the godoc of our packages online.

Lmk your thoughts, I think this disclosure makes it easier for users to learn to find what they're looking for.

@codecov
Copy link

codecov bot commented Sep 5, 2023

Codecov Report

Patch coverage has no change and project coverage change: +2.16% 🎉

Comparison is base (31d2a53) 76.77% compared to head (4a7a5c9) 78.93%.
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #73      +/-   ##
==========================================
+ Coverage   76.77%   78.93%   +2.16%     
==========================================
  Files          10       10              
  Lines         633      679      +46     
==========================================
+ Hits          486      536      +50     
+ Misses        132      130       -2     
+ Partials       15       13       -2     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

examples/README.md Outdated Show resolved Hide resolved
@maaslalani maaslalani merged commit ac0e6b1 into main Mar 4, 2024
8 checks passed
@maaslalani maaslalani deleted the api-docs branch March 4, 2024 16:18
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

Successfully merging this pull request may close these issues.

3 participants