adafruit / adafruit/circup

The arguments to `circup example` are mysterious

Open
#251 5 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
172
Forks
41
Avg merge
1d 20h
Merged PRs (30d)
1

Description

The arguments to `circup example` are not at all obvious, and the help message doesn't help too much.

I finally figured out it was `circup example ble/ble_uart_echo_test`. This is not a real pathname, despite the `/`.

It is not:
```
circup example adafruit_ble/examples/ble_uart_echo_test
circup example adafruit_ble/examples/ble_uart_echo_test.py
circup example adafruit_ble/ble_uart_echo_test
circup example adafruit_ble/ble_uart_echo_test.py
circup example ble/ble_uart_echo_test.py
circup example ble ble_uart_echo_test
```
I found `circup example --list` and then discovered I could do `circup example ble --list`, but some examples in the help text would be helpful.

Contributor guide

Open the contributing guide

Research direction

Start by running `circup example --help`, `circup example --list`, and `circup example ble --list` to understand the current CLI help and valid argument format. Update the help text with representative working examples, then rerun the help commands to confirm the examples are clear and accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.