Fixing Comment Formatting According to Best Linter Practices #98
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…. Cleaned up comment formatting across our packages
|
LGTM. Do we need to do this for tests as well? |
|
No need to do this for test files @terenc3t |
terencechain
approved these changes
May 2, 2018
|
Great. Thanks for the fixes! |
nisdas
reviewed
May 2, 2018
| // * Verifies or deploys the sharding manager contract. | ||
| // Start the sharding client | ||
| // Connects to Geth node | ||
| // Verifies or deploys the sharding manager contract | ||
| func (c *shardingClient) Start() error { |
There was a problem hiding this comment.
Hey below can you add the comment to SMCTransactor() also
nisdas
approved these changes
May 2, 2018
|
Isn’t it best practice to end comments with punctuation? Like a sentence? |
This was referenced May 2, 2018
prestonvanloon
pushed a commit
that referenced
this pull request
Jul 22, 2018
Fixing Comment Formatting According to Best Linter Practices
prestonvanloon
pushed a commit
that referenced
this pull request
Jul 22, 2018
Fixing Comment Formatting According to Best Linter Practices Former-commit-id: 07a948d
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi all,
This is a quick PR done to fix the comment formatting across our packages. I always get warnings from my linters in VSCode due to the problem of not commenting exported types. This is something we should do and is best practice. For example, if I create a type:
We have to add a comment above that begins with the name of the type as follows:
Also removed punctuation from some comments in order to be consistent with our other comments throughout our packages.