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

Small improvements on the README #187

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

rdleon
Copy link

@rdleon rdleon commented Oct 25, 2023

Description

Some small improvements for readability and clarity on the README.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

There's only documentation in this PR, a review should be enough testing.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have checked my code and corrected any misspellings

Some small improvements for readability and clarity on the README.
Copy link
Owner

@danvergara danvergara left a comment

Choose a reason for hiding this comment

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

The README.md file isn't the only documentation source available. Please, add the necessary changes to the files inside docs/, since we use mkdocs for the website .

--cfg-name string Database config name section
--config get the connection data from a config file (default is $HOME/.dblab.yaml or the current directory)
--cfg-name string Database config name section
--config Get the connection data from a config file (default is $HOME/.dblab.yaml or the current directory)
Copy link
Owner

Choose a reason for hiding this comment

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

This is the output generated by Cobra when the user adds the -h flag to the cli. I suggest to add these changes to the cmd/root.go file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants