Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[ideas] description field for targets #1235

@wlandau

Description

@wlandau

Discussed in #1230, posted by @tjmahr

Originally posted by tjmahr February 9, 2024

Help

Description

Sometimes I wish I had an description field for documenting what each target it is a more human-friendly way.

tar_target(
  name,
  command,
  description = "a field where we can briefly describe the target",
)

One could write a code comment, but this approach would be better because it could show up in tar_manifest(). It would also help generate READMEs.

Arguably, we should make the commands into simple functions and document those functions, but the trouble I have is having several end-products and recalling what they are.

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