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: Add method documentation #25

Merged
merged 2 commits into from
Jun 5, 2024
Merged

Docs: Add method documentation #25

merged 2 commits into from
Jun 5, 2024

Conversation

SchoolGuy
Copy link
Member

Fixes #22

This PR is adding documentation to all public client methods and structs. The documentation can be seen locally with:

go install golang.org/x/pkgsite/cmd/pkgsite@latest & pkgsite

@SchoolGuy SchoolGuy added this to the 0.5.0 milestone Jun 2, 2024
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+5.94% (target: -1.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (a7e3844) 2059 923 44.83%
Head commit (da16953) 1818 (-241) 923 (+0) 50.77% (+5.94%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#25) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy will stop sending the deprecated coverage status from June 5th, 2024. Learn more

Copy link

codacy-production bot commented Jun 2, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.05% (target: -1.00%) 66.67%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (a7e3844) 2059 923 44.83%
Head commit (b8a5edd) 2061 (+2) 925 (+2) 44.88% (+0.05%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#25) 3 2 66.67%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy will stop sending the deprecated coverage status from June 5th, 2024. Learn more

@SchoolGuy SchoolGuy marked this pull request as ready for review June 5, 2024 07:56
@SchoolGuy SchoolGuy added the documentation Improvements or additions to documentation label Jun 5, 2024
@SchoolGuy SchoolGuy enabled auto-merge June 5, 2024 10:18
Copy link
Contributor

@tiltingpenguin tiltingpenguin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After my fixes everything LGTM, but ideally someone should have another look

@SchoolGuy SchoolGuy merged commit 20c493c into main Jun 5, 2024
13 checks passed
@SchoolGuy SchoolGuy deleted the docs/add-godoc branch June 5, 2024 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add documentation to new API points.
2 participants