Skip to content

When documenting in the CLI reference, don't include excessive detail #1577

Description

@nathanjmcdougall

In #1565, the agent tried to introduce excessive detail into the CLI reference. It would be better to keep the reference factual.

If the context is especially import, it belongs in a separate .md file, with a hyperlink to it from the CLI reference.

Good:

- `--output-file` to write the output to a file instead of stdout.

Bad:

- `--output-file` to write the output to a file instead of stdout. This is useful to avoid issues when shell redirects (e.g. `> file.txt`) create the file before the command runs, which can influence the behaviour of `usethis show`.

Activity

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

Metadata

Metadata

Labels

agentConfiguration updates for LLM coding agents

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions