Skip to content

Various doc improvements for 1.9.0 #363

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

Merged
merged 5 commits into from
Jan 2, 2022
Merged

Various doc improvements for 1.9.0 #363

merged 5 commits into from
Jan 2, 2022

Conversation

abey79
Copy link
Owner

@abey79 abey79 commented Dec 30, 2021

Description

  • transform, scale, rotate, skew: added note/example for negative offset and --
  • Update mac install instructions (remove homebrew, add/test official installer, M1 specific instructions)
  • Improved installation instructions (especially mac)
  • improved README install instructions with links to the latest doc
  • added cookbook section on config file
  • improved top-level --help text
  • improved doc makefile (make clean && make preview)

Checklist

  • feature/fix implemented
  • code formatting ok (black and isort)
  • mypy vpype vpype_cli tests returns no error
  • tests added/updated and pytest succeeds
  • documentation added/updated
    • command docstring and option/argument help
    • README.md updated (Feature Overview)
    • CHANGELOG.md updated
    • RTD doc updated and building with no error (make clean && make html in docs/)

@codecov
Copy link

codecov bot commented Dec 30, 2021

Codecov Report

Merging #363 (096c8ce) into master (8196552) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #363   +/-   ##
=======================================
  Coverage   92.35%   92.35%           
=======================================
  Files          50       50           
  Lines        3992     3992           
  Branches      552      552           
=======================================
  Hits         3687     3687           
  Misses        203      203           
  Partials      102      102           
Impacted Files Coverage Δ
vpype_cli/cli.py 74.56% <ø> (ø)
vpype_cli/transforms.py 100.00% <ø> (ø)

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 8196552...096c8ce. Read the comment docs.

abey79 added 3 commits January 2, 2022 13:55
- improved doc makefile (make clean && make preview)
- improved README install instructions with links to the latest doc
- improved top-level --help
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 2, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@abey79 abey79 merged commit 724e16c into master Jan 2, 2022
@abey79 abey79 deleted the doc-improvements branch January 2, 2022 21:04
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.

1 participant