class Git::Commands::Describe

@overload call(*commit_ish, **options)

Execute the `git describe` command

@param commit_ish [Array<String>] zero or more commit-ish objects
  to describe

  When none are given, describes HEAD.

@param options [Hash] command options

@option options [Boolean, nil] :all (nil) use any ref found in the
  `refs/` namespace, not just tags

@option options [Boolean, nil] :tags (nil) use any tag found in the
  `refs/tags` namespace, instead of only annotated tags

@option options [Boolean, nil] :contains (nil) find the tag that
  comes after the commit and thus contains it, rather than the
  most recent tag reachable from it

@option options [Boolean, String, nil] :abbrev (nil) use this many
  digits for the abbreviated commit object name

  When `true`, emits bare `--abbrev` (which uses git's default
  length). Pass a string to emit `--abbrev=<n>`.

@option options [Boolean, String, nil] :dirty (nil) describe the
  working tree

  When `true`, appends `-dirty`; when a String, appends that
  string as the dirty mark. Maps to `--dirty[=<mark>]`.

@option options [Boolean, String, nil] :broken (nil) describe the
  working tree, treating broken links as dirty

  When `true`, appends `-broken`; when a String, appends that
  string as the broken mark. Maps to `--broken[=<mark>]`.

@option options [Integer, String] :candidates (nil) consider up
  to this many candidates

  Increasing above the default of 10 will take a slightly
  longer time but may produce a more accurate result. Maps to
  `--candidates=<n>`.

@option options [Boolean, nil] :exact_match (nil) only output exact
  matches (a tag directly references the supplied commit object)

@option options [Boolean, nil] :debug (nil) verbosely display
  information about the searching strategy being employed

@option options [Boolean, nil] :long (nil) always output the long
  format (the tag, the number of commits, and the abbreviated
  object name) even when it matches a tag exactly

@option options [String, Array<String>] :match (nil) only
  consider tags matching the given `glob(7)` pattern

  Pass an array to match against multiple patterns. Maps to
  `--match <pattern>`.

@option options [String, Array<String>] :exclude (nil) do not
  consider tags matching the given `glob(7)` pattern

  Pass an array to exclude multiple patterns. Maps to
  `--exclude <pattern>`.

@option options [Boolean, nil] :always (nil) show uniquely
  abbreviated commit object as fallback when the commit cannot
  be described

@option options [Boolean, nil] :first_parent (nil) follow only the
  first parent of a merge commit

@return [Git::CommandLine::Result] the result of calling
  `git describe`

@raise [ArgumentError] if unsupported options are provided

@raise [Git::FailedError] if git exits with a non-zero exit
  status

@api public