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

FEATURE - Improving information about help #256

Conversation

brunats
Copy link
Contributor

@brunats brunats commented Jul 8, 2020

- What I did
Updated the help messages for the core commands and added comments to some public functions found in the modified files.

- How I did it

Changing the help messages according to the documentation and adding comments on the necessary public functions (in files already changed previously).

- How to verify it

Exec rit
Before:
antes

Now:
depois

Prints updated on Jul 14 at 7:03 pm

- Description for the changelog

Improving information about help

@brunasilvazup brunasilvazup added the 🚧 WIP Work in Progress label Jul 8, 2020
@brunasilvazup brunasilvazup self-assigned this Jul 8, 2020
@codecov-commenter
Copy link

codecov-commenter commented Jul 8, 2020

Codecov Report

Merging #256 into master will increase coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #256      +/-   ##
==========================================
+ Coverage   67.43%   67.45%   +0.01%     
==========================================
  Files          71       71              
  Lines        2721     2722       +1     
==========================================
+ Hits         1835     1836       +1     
  Misses        656      656              
  Partials      230      230              
Impacted Files Coverage Δ
pkg/cmd/create_formula.go 57.60% <ø> (ø)
pkg/cmd/logout.go 85.71% <ø> (ø)
pkg/cmd/add.go 100.00% <100.00%> (ø)
pkg/cmd/autocomplete.go 96.61% <100.00%> (+0.05%) ⬆️
pkg/cmd/build.go 100.00% <100.00%> (ø)
pkg/cmd/create.go 100.00% <100.00%> (ø)
pkg/cmd/delete.go 100.00% <100.00%> (ø)
pkg/cmd/delete_context.go 33.33% <100.00%> (ø)
pkg/cmd/delete_repo.go 39.58% <100.00%> (ø)
pkg/cmd/init.go 77.47% <100.00%> (ø)
... and 5 more

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 efd4434...6c3bf27. Read the comment docs.

@brunats brunats marked this pull request as ready for review July 9, 2020 12:42
@brunasilvazup brunasilvazup removed the 🚧 WIP Work in Progress label Jul 9, 2020
Copy link
Contributor

@victor-schumacher victor-schumacher left a comment

Choose a reason for hiding this comment

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

Good job! It became much clearer with examples.
Do you think it is a good idea not to use the word "objects"? For me it is not valuable information.

@brunats
Copy link
Contributor Author

brunats commented Jul 9, 2020

Good job! It became much clearer with examples.
Do you think it is a good idea not to use the word "objects"? For me it is not valuable information.

Looking again, I agree with you, let's see what the other reviewers think and depending on I remove the 'objects'.

@brunats brunats requested review from marcoscostazup and removed request for kaduartur July 14, 2020 22:05
@viniciusramosdefaria viniciusramosdefaria merged commit da7b5f2 into ZupIT:master Jul 16, 2020
@brunats brunats mentioned this pull request Jul 24, 2020
@brunats brunats deleted the feature/improving-information-about-help branch August 26, 2020 20:33
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.

6 participants