Skip to content

fix missing documentation lints#790

Merged
majewsky merged 1 commit intomasterfrom
missing_docs_findings
Nov 5, 2025
Merged

fix missing documentation lints#790
majewsky merged 1 commit intomasterfrom
missing_docs_findings

Conversation

@wagnerd3
Copy link
Copy Markdown
Contributor

@wagnerd3 wagnerd3 commented Nov 5, 2025

This is a PR to showcase the impact of the exported-linting of the revive linter, for which I introduced support in go-makefile-maker: sapcc/go-makefile-maker#403

As you can see, this lint this does not just highlight missing comments, you have different root causes for missing comments:

  • find comments which were forgotten to update when a function was renamed (/api/commitment.go)
  • find missing interface implementation comments (As interface implementations are not explicit in go, I find this to be important)
  • highlight functions which can actually be un-exported (the majority of changes in /liquids )

@wagnerd3 wagnerd3 force-pushed the missing_docs_findings branch from d43c005 to 4d4482d Compare November 5, 2025 10:41
majewsky
majewsky previously approved these changes Nov 5, 2025
@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 5, 2025

Merging this branch will increase overall coverage

Impacted Packages Coverage Δ 🤖
github.com/sapcc/limes/internal/api 76.97% (+0.09%) 👍
github.com/sapcc/limes/internal/collector 82.03% (ø)
github.com/sapcc/limes/internal/datamodel 86.29% (ø)
github.com/sapcc/limes/internal/db 81.55% (ø)
github.com/sapcc/limes/internal/liquids 0.00% (ø)
github.com/sapcc/limes/internal/liquids/archer 0.00% (ø)
github.com/sapcc/limes/internal/liquids/cinder 0.00% (ø)
github.com/sapcc/limes/internal/liquids/cronus 0.00% (ø)
github.com/sapcc/limes/internal/liquids/designate 0.00% (ø)
github.com/sapcc/limes/internal/liquids/ironic 0.00% (ø)
github.com/sapcc/limes/internal/liquids/manila 0.00% (ø)
github.com/sapcc/limes/internal/liquids/neutron 0.00% (ø)
github.com/sapcc/limes/internal/liquids/nova 0.00% (ø)
github.com/sapcc/limes/internal/liquids/octavia 0.00% (ø)
github.com/sapcc/limes/internal/liquids/swift 0.00% (ø)
github.com/sapcc/limes/internal/reports 88.34% (ø)
github.com/sapcc/limes/internal/test 89.61% (ø)
github.com/sapcc/limes/internal/util 82.80% (ø)

Coverage by file

Changed files (no unit tests)

Changed File Coverage Δ Total Covered Missed 🤖
github.com/sapcc/limes/internal/api/commitment.go 78.50% (ø) 5140 4035 1105
github.com/sapcc/limes/internal/api/core.go 78.51% (+1.28%) 605 (-10) 475 130 (-10) 👍
github.com/sapcc/limes/internal/api/liquid.go 89.29% (ø) 280 250 30
github.com/sapcc/limes/internal/api/stream.go 76.00% (ø) 125 95 30
github.com/sapcc/limes/internal/api/utils.go 25.00% (ø) 40 10 30
github.com/sapcc/limes/internal/collector/consistency.go 89.47% (ø) 95 85 10
github.com/sapcc/limes/internal/collector/mail_delivery.go 85.71% (ø) 140 120 20
github.com/sapcc/limes/internal/collector/metrics.go 85.86% (ø) 1520 1305 215
github.com/sapcc/limes/internal/datamodel/allocation_stats.go 91.67% (ø) 300 275 25
github.com/sapcc/limes/internal/datamodel/apply_computed_project_quota.go 85.65% (ø) 1185 1015 170
github.com/sapcc/limes/internal/db/buildindex.go 88.24% (ø) 68 60 8
github.com/sapcc/limes/internal/liquids/archer/client.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/archer/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/cinder/capacity.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/cinder/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/cinder/usage.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/cronus/client.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/cronus/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/designate/client.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/designate/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/ironic/capacity.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/ironic/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/ironic/usage.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/manila/capacity.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/manila/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/manila/sharetype.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/manila/usage.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/neutron/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/binpack_simulation.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/capacity.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/flavor_selection.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/hypervisor_selection.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/hypervisor_subcapacity.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/ostype_prober.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/subresources.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/nova/usage.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/octavia/client.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/octavia/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/swift/liquid.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/liquids/types.go 0.00% (ø) 0 0 0
github.com/sapcc/limes/internal/reports/error.go 87.80% (ø) 164 144 20
github.com/sapcc/limes/internal/reports/filter.go 97.62% (ø) 168 164 4
github.com/sapcc/limes/internal/test/mock_liquid_client.go 100.00% (ø) 92 92 0
github.com/sapcc/limes/internal/test/setup.go 88.50% (ø) 452 400 52
github.com/sapcc/limes/internal/util/datatypes.go 87.50% (ø) 40 35 5
github.com/sapcc/limes/internal/util/http.go 0.00% (ø) 35 0 35
github.com/sapcc/limes/internal/util/timeseries.go 98.04% (ø) 255 250 5

Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code.

Changed unit test files

  • github.com/sapcc/limes/internal/api/api_test.go

@majewsky majewsky merged commit 74e3ac8 into master Nov 5, 2025
13 of 15 checks passed
@majewsky majewsky deleted the missing_docs_findings branch November 5, 2025 13:01
@wagnerd3
Copy link
Copy Markdown
Contributor Author

wagnerd3 commented Nov 5, 2025

Flapping tests fixed in #792.

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.

2 participants