ocaml / ocaml/dune

--display not documented in manual

Open
#3,044 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cli docs
Dominant language
OCaml
Stars
1.9k
Forks
500
Avg merge
15h 21m
Merged PRs (30d)
277

Description

Dear Dune Team,

as far as I can tell - search in (https://readthedocs.org/projects/dune/downloads/pdf/stable/) - the --display command line option is not documented in the manual. I am not sure if it is deprecated but I don't think so since --display=short doesn't seem to be achievable otherwise. It would also be nice to document the relation between --verbose and --display=verbose.

In general a command line reference would be nice to have in the manual.

Best regards,

Michael

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by searching the manual and the command-line option definitions for --display and --verbose, then determine how their behaviors relate. Update the manual with the missing option and relationship, and verify the generated manual documents the supported values, including short and verbose.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
56/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.