Skip to content
This repository has been archived by the owner on Nov 16, 2022. It is now read-only.

chain/doc: Improve code comments in module.go / msg.go / params.go #2344

Merged
merged 4 commits into from
Jul 31, 2020

Conversation

sorawit
Copy link
Member

@sorawit sorawit commented Jul 30, 2020

Implementation details

This PR updates the comments in module.go and msg.go to explain the function beyond just saying that a function implements a certain interface. Also add comments explaining module parameters in params.go.

Please ensure the following requirements are met before submitting a pull request:

  • The pull request is targeted against the correct target branch
  • The pull request includes a description of the implementation/work done in detail.
  • You have added a relevant changelog entry to CHANGELOG_UNRELEASED.md
  • You have re-reviewed the files affected by the pull request (e.g. using the Files changed tab in the Github PR explorer)

@sorawit sorawit requested review from Benzbeeb and taobun July 30, 2020 16:02
@render
Copy link

render bot commented Jul 30, 2020

@sorawit sorawit merged commit ed55831 into master Jul 31, 2020
@sorawit sorawit deleted the improve-chain-comments branch July 31, 2020 06:59
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants