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.

Sign up for GitHub

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

Jump to bottom

[x/gamm] Document PoolI interface in x/gamm/types/pool.go #1183

Closed
Tracked by #1450
p0mvn opened this issue Mar 31, 2022 · 0 comments · Fixed by #1207
Closed
Tracked by #1450

[x/gamm] Document PoolI interface in x/gamm/types/pool.go #1183

p0mvn opened this issue Mar 31, 2022 · 0 comments · Fixed by #1207
Assignees
@ValarDragon
Labels
C:docs Improvements or additions to documentation C:x/gamm Changes, features and bugs related to the gamm module. T:task ⚙️ A task belongs to a story

Comments

@p0mvn
Copy link
Member

p0mvn commented Mar 31, 2022 •
edited
Loading

Background

The methods in the pool interface are the meat n bones of the AMM state machine, or are at least a large part of it.

Being so, each of these methods in the interface should be very very well documented with godocs.

Many of these methods already have some godocs next to the implementation. E.g.:

osmosis/x/gamm/pool-models/balancer/amm.go

Line 42 in a68928e

// CalcOutAmtGivenIn calculates token to be swapped out given

We should ensure that these match

Originally posted by @alexanderbez in #1147 (comment)

Acceptance Criteria

  • Each of he PoolI methods is well documented
  • Ensure that documentation matches the godoc next to the implementation of the method (

    osmosis/x/gamm/pool-models/balancer/amm.go

    Line 42 in a68928e

    // CalcOutAmtGivenIn calculates token to be swapped out given
    )
@p0mvn p0mvn added the C:docs Improvements or additions to documentation label Mar 31, 2022
@p0mvn p0mvn moved this to 🔍 Needs Review in Osmosis Chain Development Mar 31, 2022
@p0mvn p0mvn moved this from 🔍 Needs Review to 🕒 Todo in Osmosis Chain Development Mar 31, 2022
@p0mvn p0mvn mentioned this issue Mar 31, 2022
Closed
6 tasks
@alexanderbez alexanderbez added the C:x/gamm Changes, features and bugs related to the gamm module. label Mar 31, 2022
@p0mvn p0mvn mentioned this issue Mar 31, 2022
Merged
4 tasks
@daniel-farina daniel-farina added the T:task ⚙️ A task belongs to a story label Apr 4, 2022
@ValarDragon ValarDragon moved this from 🕒 Todo to 🏃 In Progress in Osmosis Chain Development Apr 4, 2022
@ValarDragon ValarDragon moved this from 🏃 In Progress to 🕒 Todo in Osmosis Chain Development Apr 4, 2022
@ValarDragon ValarDragon self-assigned this Apr 4, 2022
@ValarDragon ValarDragon mentioned this issue Apr 6, 2022
Merged
4 tasks
@ValarDragon ValarDragon moved this from 🕒 Todo to 🏃 In Progress in Osmosis Chain Development Apr 6, 2022
@mergify mergify bot closed this as completed in #1207 Apr 6, 2022
Repository owner moved this from 🏃 In Progress to ✅ Done in Osmosis Chain Development Apr 6, 2022
mergify bot pushed a commit that referenced this issue Apr 6, 2022
@ValarDragon
Add godocs for pool interface (#1207)
92baf4f 
Closes: #1183

## Description

Adds comments for all of the pool interface methods.

Deletes some deadcode around the IsActive function / test thats not really achieving much at the moment. It also changes its API to take in ctx directly.

______

For contributor use:

- [ ] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/gaia/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [ ] Re-reviewed `Files changed` in the Github PR explorer
@p0mvn p0mvn changed the title Document PoolI interface in x/gamm/types/pool.go [x/gamm] Document PoolI interface in x/gamm/types/pool.go May 9, 2022
@p0mvn p0mvn mentioned this issue May 9, 2022
Closed
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ValarDragon ValarDragon

Labels
C:docs Improvements or additions to documentation C:x/gamm Changes, features and bugs related to the gamm module. T:task ⚙️ A task belongs to a story
Projects
Osmosis Chain Development
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add godocs for pool interface osmosis-labs/osmosis
4 participants
@alexanderbez @ValarDragon @daniel-farina @p0mvn