Skip to content

Why don't you write the default value in the description in the inputs options? #1659

Open
@minsoo-web

Description

@minsoo-web

Background

I didn't realize that the default value of the fetch-depth option is 1 until I looked in the README
Of course, user should read the documentation before using it, but if the default value was included in the description, I could have solved this problem with a tooltip that appears on hover.

image

Suggestion

Why not include a default value in the description?

fetch-depth:
    description: 'Number of commits to fetch. 0 indicates all history for all branches and tags. Default value is 1'
    default: 1

like this?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions