Skip to content

Add glossary and disambiguate cabal vs Cabal - #10631

Open
philderbeast wants to merge 11 commits into
haskell:masterfrom
cabalism:doc/add-glossary
Open

philderbeast wants to merge 11 commits into
haskell:masterfrom
cabalism:doc/add-glossary

Conversation

@philderbeast

@philderbeast philderbeast commented Dec 10, 2024 •

Copy link
Copy Markdown
Collaborator

Fixes #9976, by referring to glossary terms. Adds a glossary page to the users guide and links to it from the other pages.

For the styling, sets white-space: nowrap on table cells, to prevent glossary tables cells overflow. This applies only to tables with the wrap-cells class.

I'll squash commits before applying the merge label if this pull request is approved.

What's in it

  • Alphabetical listing: with entries with synonyms placed together.
  • Terms by category: Cabal-specific, Haskell-specific, and General tables.
  • Easily confused terms: a table of terms that look alike or overlap with a sentence or two on how they differ.
  • Links from other pages: :term: roles are linked at first use on a page but cabal and cabal-install are linked wherever they refer to the tool.

QA Notes

This is a doc-only change.

Running make users-guide should build the guide with no warnings.


@philderbeast
philderbeast marked this pull request as draft December 10, 2024 02:40
Comment thread doc/cabal-project-description-file.rst Outdated
satisfy this requirement.

When ``cabal.project`` doesn't exist, ``cabal-install`` fabricates an ephemeral
When ``cabal.project`` doesn't exist, :term:`cabal-install:exe:cabal` fabricates an ephemeral

@geekosaur geekosaur Dec 10, 2024 •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other places, cabal-install describes the package and cabal the command.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is how it should be, isn't it? I've dropped uses of :term:`cabal-install:exe:cabal`.

Comment thread doc/cabal-project-description-file.rst
Comment thread doc/external-commands.rst Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Disambiguate docs, cabal versus Cabal

2 participants