circleci-docs icon indicating copy to clipboard operation
circleci-docs copied to clipboard

Incorrect values for --timings-type parameter

Open ppaulis opened this issue 2 months ago • 1 comments

The doc for --timings-type is incorrect. The circleci cli tool gives the following message:

Error: invalid argument "file" for "--timings-type" flag: unknown timings type, allowed values are "filename", "classname", "testname", and "autodetect"

Description

Fixed the list of values for the --timings-type parameter.

Reasons

Because the current list is incomplete and wrong.

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs):

  • [x] Break up walls of text by adding paragraph breaks.
  • [x] Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • [x] Keep the title between 20 and 70 characters.
  • [x] Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • [x] Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • [x] Include relevant backlinks to other CircleCI docs/pages.

ppaulis avatar Nov 21 '25 15:11 ppaulis

Thank you for fixing this for us @ppaulis! 🎉

We also have a reference guide for the environment CLI now so I might consider removing the duplicated tables on this page to avoid more confusion in future: https://circleci.com/docs/guides/toolkit/environment-cli-usage-guide/#run-2

rosieyohannan avatar Dec 10 '25 11:12 rosieyohannan