docs: Liquidity godoc QA

[dongsam]

Description

#176
It is PR to get the liquidityd godoc QA suggestions based on the sources

Found 3 files that looked like they might need edits, see those changes staged in this PR.
@dongsam can you provide the file links for each file, from the correct repo, so I can address those edits here?
all help appreciated.

For this request:
https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/keeper#pkg-functions
https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/keeper#pkg-types
https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/types#pkg-functions
https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/types#pkg-types
https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/simulation#pkg-functions

what are the specific files that I can open and edit? please and thank you, maybe @kogisin knows?

---historical

temporarily remove and revert to create diff for review

ref

• https://blog.golang.org/godoc
• https://pkg.go.dev/github.com/tendermint/[email protected]

[codecov]

Codecov Report

Merging #217 (df93550) into develop (ee1aa8b) will increase coverage by 0.33%.
The diff coverage is 91.37%.

@@             Coverage Diff             @@
##           develop     #217      +/-   ##
===========================================
+ Coverage    82.93%   83.26%   +0.33%     
===========================================
  Files           20       20              
  Lines         2215     2247      +32     
===========================================
+ Hits          1837     1871      +34     
+ Misses         208      207       -1     
+ Partials       170      169       -1     

Impacted Files	Coverage Δ
x/liquidity/keeper/invariants.go	61.63% <76.47%> (+2.85%)	⬆️
x/liquidity/keeper/liquidity_pool.go	79.60% <96.00%> (+0.93%)	⬆️
x/liquidity/keeper/batch.go	86.36% <100.00%> (ø)
x/liquidity/keeper/swap.go	87.09% <100.00%> (+1.38%)	⬆️
x/liquidity/types/msgs.go	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ee1aa8b...df93550. Read the comment docs.

[barriebyron]

@dongsam these go docs are autogenerated, right? let's focus on the CLI, swagger, and markdown docs and when that content is updated then this autogenerated go doc content will also be updated, right? You can move in the suggested changes from the CLI, swagger, and so on here. Let me know if you have questions. I'm here to help!

[dongsam]

@dongsam these go docs are autogenerated, right? let's focus on the CLI, swagger, and markdown docs and when that content is updated then this autogenerated go doc content will also be updated, right? You can move in the suggested changes from the CLI, swagger, and so on here. Let me know if you have questions. I'm here to help!

@barriebyron You're right, go docs are autogenerated, markdown docs and *.pb.go, *pb.gw.go files autogenerated by *.proto will also be updated
So I think it would be good to see the parts except for swagger, markdown, cli, and tx in the PR.

for example, https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/keeper#Keeper.ExecutePoolBatch is autogenerated from

liquidity/x/liquidity/keeper/batch.go

Lines 81 to 83 in fb15225

	// In case of deposit, withdraw, and swap msgs, unlike other normal tx msgs,
	// collect them in the liquidity pool batch and perform an execution once at the endblock to calculate and use the universal price.
	func (k Keeper) ExecutePoolBatch(ctx sdk.Context) {

As above, it would be good to look at the parts where each func, type structure has a comment.
It mainly exists below

• https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/keeper#pkg-functions
• https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/keeper#pkg-types
• https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/types#pkg-functions
• https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/types#pkg-types
• https://pkg.go.dev/github.com/tendermint/[email protected]/x/liquidity/simulation#pkg-functions

[barriebyron]

I made editorial changes on 3 files, but I'm sure we have more. Approved this round, let me know what else needs my attention.