yard icon indicating copy to clipboard operation
yard copied to clipboard
verified publisher icon lsegal

Difference between `--no-api` and `--hide-api`?

Open thomthom opened this issue 5 years ago • 1 comments

What is the difference between using --no-api and --hide-api?

thomthom avatar May 14 '20 12:05 thomthom

  1. --no-api does not take a TAG argument (optparse makes this hard to show) and will ignore objects that do not have an @api tag attached. It's equivalent to --api every --api other --api api --api used. See specs for examples.
  2. --hide-api TAG will hide objects for a particular API tag.

Unfortunately using the --[no-] prefix in optparse does not allow you to take an argument afterward, hence the use of --hide-api for that behavior.

lsegal avatar May 14 '20 15:05 lsegal