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

chore: app package housekeeping #1125

Merged
merged 9 commits into from
Mar 24, 2022
Merged

chore: app package housekeeping #1125

merged 9 commits into from
Mar 24, 2022

Conversation

alexanderbez
Copy link
Contributor

Description

Some general linting and housekeeping to the app package. Changes are meant to be non-contentious and ultimately make the code and style consistent and most importantly legible.

Feel free to close/deny if deemed too contentious :)


For contributor use:

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • 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

@codecov-commenter
Copy link

codecov-commenter commented Mar 22, 2022

Codecov Report

Merging #1125 (a6857d8) into main (f1389ee) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1125      +/-   ##
==========================================
+ Coverage   19.90%   19.92%   +0.01%     
==========================================
  Files         200      200              
  Lines       25498    25503       +5     
==========================================
+ Hits         5076     5081       +5     
  Misses      19515    19515              
  Partials      907      907              
Impacted Files Coverage Δ
app/upgrades/v4/prop12.go 60.00% <ø> (ø)
app/upgrades/v4/upgrades.go 100.00% <100.00%> (ø)
x/epochs/abci.go 100.00% <0.00%> (ø)
x/txfees/keeper/feedecorator.go 75.00% <0.00%> (ø)
x/gamm/keeper/pool_service.go 60.25% <0.00%> (+1.04%) ⬆️

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 f1389ee...a6857d8. Read the comment docs.

app/app.go Outdated

// Osmosis application prarmeters
Copy link
Member

Choose a reason for hiding this comment

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

Do you think we should revert these comments / the prior ordering of imports here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You mean keep them?

Import blocks aren't meant to be annotated. If you think devs would really find them useful, I can revert :)

Copy link
Member

Choose a reason for hiding this comment

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

@faddat was the one who added them, presumably he's found it helpful when explaining app.go's to people.

We could put the same comments in the AppKeepers struct though, I don't think theres anything particularly important about this info being in the imports

Copy link
Contributor Author

@alexanderbez alexanderbez Mar 23, 2022

Choose a reason for hiding this comment

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

Gotcha, yeah I mean I guess I can see how they're helpful, but then a few questions/points arise:

  • Do I now too have to keep these up to date and add them for any new imports (burden on me)
  • Import blocks become extremely verbose

@faddat are you against removing these annotations?

@alexanderbez alexanderbez marked this pull request as ready for review March 23, 2022 13:42
Copy link
Member

@ValarDragon ValarDragon left a comment

Choose a reason for hiding this comment

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

LGTM! I'm fine with removing the import annotations, and moving the equivalent annotations elsewhere in structs directly

@alexanderbez
Copy link
Contributor Author

@ValarDragon can you merge this whenever you get a chance?

@ValarDragon ValarDragon merged commit b8c5af5 into main Mar 24, 2022
@ValarDragon ValarDragon deleted the bez/app-housekeeping branch March 24, 2022 04:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants