search

bjlittle / geovista

Cartographic rendering and mesh analytics powered by PyVista
https://geovista.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
159 stars 26 forks source link

cli docs tidy and options rebrand #692

Closed bjlittle closed 8 months ago

bjlittle commented 8 months ago

🚀 Pull Request

Description

This pull-request opts not to document the geovista.cli as there is no expectation for the user to import geovista.cli.

However, the geovista.cli.main implements the entry point to the command line interface (CLI) using click, which is self-documenting from the CLI e.g., geovista --help.

The download command option -o|--output is rebranded to -t|--target, and the examples command ensures that the name of an example is provided.

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (2a8dc30) 94.65% compared to head (84aacf7) 94.65%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #692 +/- ## ======================================= Coverage 94.65% 94.65% ======================================= Files 129 129 Lines 4900 4900 ======================================= Hits 4638 4638 Misses 262 262 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.