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

CLI documentation improvements #440

Merged
merged 7 commits into from
Aug 17, 2020
Merged

CLI documentation improvements #440

merged 7 commits into from
Aug 17, 2020

Conversation

Thomsch
Copy link
Contributor

@Thomsch Thomsch commented Aug 14, 2020

Description

The command line subcommands do not have descriptions that make it hard to use Oríon without looking at the documentation.

Changes

This PR fixes a few documentation problems and adds a short and long description for each subcommand, indicating what are their purposes.

Checklist

Tests

  • I added corresponding tests for bug fixes and new features. If possible, the tests fail without the changes
  • All new and existing tests are passing ($ tox -e py38; replace 38 by your Python version if necessary)

Documentation

  • I have updated the relevant documentation related to my changes

Quality

  • I have read the CONTRIBUTING doc
  • My commits messages follow this format
  • My code follows the style guidelines ($ tox -e lint)

@Thomsch Thomsch added enhancement Improves a feature or non-functional aspects (e.g., optimization, prettify, technical debt) documentation Regarding description, documentation, tutorials, etc labels Aug 14, 2020
@Thomsch Thomsch added this to the v0.1.9 milestone Aug 14, 2020
@Thomsch Thomsch requested a review from bouthilx August 14, 2020 22:06
@codecov-commenter
Copy link

codecov-commenter commented Aug 17, 2020

Codecov Report

Merging #440 into develop will increase coverage by 0.00%.
The diff coverage is 50.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #440   +/-   ##
========================================
  Coverage    48.95%   48.95%           
========================================
  Files           80       80           
  Lines        13640    13641    +1     
  Branches       329      329           
========================================
+ Hits          6677     6678    +1     
  Misses        6946     6946           
  Partials        17       17           
Impacted Files Coverage Δ
src/orion/core/cli/test_db.py 57.14% <50.00%> (+3.29%) ⬆️

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 f3b982b...7d5f9c1. Read the comment docs.

Copy link
Member

@bouthilx bouthilx left a comment

Choose a reason for hiding this comment

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

Thanks!! :)

@bouthilx bouthilx merged commit 2ec8ebd into Epistimio:develop Aug 17, 2020
@Thomsch Thomsch deleted the cli-documentation branch August 17, 2020 21:46
This was referenced Nov 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Regarding description, documentation, tutorials, etc enhancement Improves a feature or non-functional aspects (e.g., optimization, prettify, technical debt)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants