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

module/types code hygiene - utilize map access 2nd return value #9098

Merged
merged 6 commits into from
Apr 13, 2021

Conversation

technicallyty
Copy link
Contributor

@technicallyty technicallyty commented Apr 12, 2021

Description

This PR cleans up a small snippet of code in types/module/module.go

Currently, to check if a module exists in the fromVM map, we check for the default/nil value in the map.

This PR utilizes the 2nd return value from map accesses, a boolean, which is true if the key exists in the map, false otherwise. This makes not only the code a bit more readable, but also the documentation surrounding it. Ref: In-Place store migration docs.

closes: N/A


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@technicallyty technicallyty added the Type: Code Hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity. label Apr 12, 2021
@codecov
Copy link

codecov bot commented Apr 12, 2021

Codecov Report

Merging #9098 (5c06fda) into master (a465ae1) will not change coverage.
The diff coverage is 0.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #9098   +/-   ##
=======================================
  Coverage   58.79%   58.79%           
=======================================
  Files         583      583           
  Lines       32750    32750           
=======================================
  Hits        19255    19255           
  Misses      11218    11218           
  Partials     2277     2277           
Impacted Files Coverage Δ
types/module/module.go 68.36% <0.00%> (ø)

@tac0turtle tac0turtle added the A:automerge Automatically merge PR once all prerequisites pass. label Apr 13, 2021
@mergify mergify bot merged commit 3ebf06c into master Apr 13, 2021
@mergify mergify bot deleted the ty-migration_cleanup branch April 13, 2021 19:00
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
…os#9098)

* update docs/code to utilize map access return values

* remove mock module in fromVM to simulate truly non-existent module

* update test docs to refelect change

Co-authored-by: technicallyty <48813565+tytech3@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. Type: Code Hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants