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: update funcs documentation with go 1.19 doc standards #499

Merged
merged 1 commit into from Dec 20, 2022

Conversation

morremeyer
Copy link
Member

go 1.19 introduced more features for documentation comments.

swagger switching to use tabs to indent (swaggo/swag#1386) broke the formatting for the backend since it did not have any actual go docs beyond the swagger comments yet.

With this PR, go docs are added, resolving this issue.

@morremeyer morremeyer requested a review from a team as a code owner December 20, 2022 12:57
@codecov
Copy link

codecov bot commented Dec 20, 2022

Codecov Report

Base: 87.74% // Head: 87.74% // No change to project coverage 👍

Coverage data is based on head (476a1c2) compared to base (11fe175).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #499   +/-   ##
=======================================
  Coverage   87.74%   87.74%           
=======================================
  Files          24       24           
  Lines        2937     2937           
=======================================
  Hits         2577     2577           
  Misses        282      282           
  Partials       78       78           
Impacted Files Coverage Δ
pkg/controllers/account.go 96.10% <ø> (ø)
pkg/controllers/allocation.go 98.07% <ø> (ø)
pkg/controllers/budget.go 66.93% <ø> (ø)
pkg/controllers/category.go 94.70% <ø> (ø)
pkg/controllers/cleanup.go 24.32% <ø> (ø)
pkg/controllers/envelope.go 95.00% <ø> (ø)
pkg/controllers/import.go 77.27% <ø> (ø)
pkg/controllers/month.go 81.52% <ø> (ø)
pkg/controllers/month_config.go 92.70% <ø> (ø)
pkg/controllers/transaction.go 97.42% <ø> (ø)
... and 1 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@morremeyer morremeyer merged commit 20c3dc3 into main Dec 20, 2022
@morremeyer morremeyer deleted the docs/go-1-19-docs branch December 20, 2022 13:00
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.

None yet

1 participant