search

zooniverse / panoptes-cli

A command-line interface for Panoptes
Apache License 2.0
18 stars 5 forks source link

add examples for retire and unretiring subjects #229

Closed camallen closed 2 years ago

camallen commented 2 years ago

This PR adds examples to the readme for retiring subjects and unretiring subjects for a workflow and is a follow up to #228 based on review comments, https://github.com/zooniverse/panoptes-cli/pull/228#pullrequestreview-991001808

I'll note that a while back it was not desired to overload the readme but rather we ensure the built in CLI help cmds provide enough context to ensure folks can find the behviours they need, https://github.com/zooniverse/panoptes-cli/pull/97#pullrequestreview-205265132

From Adam: This is fine for now, but there are a lot of examples in the readme already, so I'm wary of adding more – especially ones for simple functionality like this. I assume this has come up from someone asking how to do this. If people aren't finding things like this in the built in help we should think about adding some organised online documentation as well.