kitovu-bot / kitovu

OpenHSR Connect 2
GNU General Public License v3.0
5 stars 2 forks source link

Feature add docs and edit cli commands #21

Closed ThunderKey closed 6 years ago

ThunderKey commented 6 years ago

Issues:

@The-Compiler, @bytinbit what are your opinions?

codecov[bot] commented 6 years ago

Codecov Report

Merging #21 into master will increase coverage by 0.49%. The diff coverage is 97.93%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #21      +/-   ##
==========================================
+ Coverage   91.28%   91.78%   +0.49%     
==========================================
  Files          31       31              
  Lines        1194     1291      +97     
  Branches       74       82       +8     
==========================================
+ Hits         1090     1185      +95     
- Misses         93       94       +1     
- Partials       11       12       +1
Impacted Files Coverage Δ
tests/test_cli.py 100% <100%> (ø) :arrow_up:
src/kitovu/cli.py 79.66% <93.33%> (+12.99%) :arrow_up:
tests/sync/test_syncing.py 100% <0%> (ø) :arrow_up:

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 b3f9fd4...a56de94. Read the comment docs.

The-Compiler commented 6 years ago
  • [ ] Make kitovu docs version aware.
  • How could we make different versions in readthedocs?

I think RTD does that automatically once tags are pushed - see e.g. the "v: latest" thing at the bottom right on https://docs.pytest.org/.

However, I think until we actually have a first release, it's okay to link to the /latest URL like you did.

  • [ ] Get the default filename in `kitovu edit
  • Currently it is built in the settings.py
  • Option 1: import settings.py in the cli.py => circular dependencies

I don't follow - why circular? cli (at the top) imports settings, but not the other way around.