Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unmentioned commands to the docs. #7978

Closed
philderbeast opened this issue Feb 14, 2022 · 0 comments · Fixed by #8309
Closed

Add unmentioned commands to the docs. #7978

philderbeast opened this issue Feb 14, 2022 · 0 comments · Fixed by #8309

Comments

@philderbeast
Copy link
Collaborator

philderbeast commented Feb 14, 2022

The docs claim to "give an in-depth description of all the commands" but this isn't so.

Doing a quick check, it looks like commands fetch, info, list, user-config, upload, check, get, hscolour and report are not discussed. The init command is discussed in the quickstart of developing-packages.rst so maybe we should link to it? Same goes for the outdated and gen-bounds commands that are discussed in cabal-package.rst.

I see that hscolour is deprecated. Should we move it alongside the v1 stuff (as a separate issue and PR)?

$ cabal help hscolour
Generate HsColour colourised code, in HTML format.

Usage: cabal hscolour [FLAGS]

Requires the hscolour program.

Deprecated in favour of 'cabal haddock --hyperlink-source'.

Originally posted by @philderbeast in #7964 (comment)

@philderbeast philderbeast changed the title nmentioned commands Add unmentioned commands to the docs. Feb 14, 2022
@ffaf1 ffaf1 mentioned this issue Jul 21, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants