Skip to content

DefaultText is not respected for generating documentation #2210

Description

@6543

My urfave/cli version is

( Put the version of urfave/cli that you are using here )

Checklist

  • Are you running the latest v3 release? The list of releases is here.
  • Did you check the manual for your release? The v3 manual is here
  • Did you perform a search about this problem? Here's the GitHub guide about searching.

Dependency Management

  • My project is using go modules.
  • My project is automatically downloading the latest version (renovate).

Describe the bug

As per urfave/cli-docs#11 (comment)

I subled over the same problem, where i want to change the text for the default value.
Default: os.TempDir() so the val changes depending on the system generating the docs :/

This makes a bad description at https://woodpecker-ci.org/docs/cli#exec (search for flag --backend-local-temp-dir)

To reproduce

Just use a changing default and DefaultText and try to generate markdown docs ...

Observed behavior

The DefaultText works as expected, when used with the --help flag on a compiled cli binary

Expected behavior

Show the DefaultText instead of resolving Default value.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/v3relates to / is being considered for v3kind/bugdescribes or fixes a bugstatus/triagemaintainers still need to look into thisstatus/waiting-for-responseWaiting for response from original requester

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions