Don't use lists in footnotes

[philderbeast]

Fixes #11246. With the read the docs theme at versions >=0.18 we can't use lists within footnotes. I removed the list and put its elements inline as sentences within the footnote paragraph.

---

• Patches conform to the coding conventions.
• Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

[geekosaur]

I'd actually consider that a bug they should fix, but it sounds like that's unlikely.

[ulysses4ever]

I think the text should use "First, ... Second, ... Third, ..." or something

[philderbeast]

I think the text should use "First, ... Second, ... Third, ..." or something

@ulysses4ever I numbered the sentences.

[ulysses4ever]

@philderbeast it'd be more idiomatic to use the actual words "first", etc. instead of numbers.

[philderbeast]

it'd be more idiomatic to use the actual words "first", etc. instead of numbers.

I asked Google and its AI didn't suggest that. My question for it was "how to number bullet points as sentences within a paragraph".

[geekosaur]

My take on this is that things like "1." or "(a)" not in a proper list are fine for casual writing, but the words should be used within sentences for more formal writing such as in manuals.

I should probably add that I'm from an older school and notions of what's acceptable in formal writing may have shifted a bit, driven in particular by wider use of casual writing starting with email.

[ulysses4ever]

"it" became a bit ambiguous when the list was split into separate sentences, I think.

[ulysses4ever]

Great! One last ask: could you wrap build-depends into code fences (double backticks in RST i think?..).

[ulysses4ever]

Rebasing on master should help with CI

[philderbeast]

No need to backport this one is there?

[philderbeast]

I opted to squash manually but left the [squash+merge me] label.

[ulysses4ever]

theoretically, we could bacckport to 3.16 and then push a new tag that RTD would pick up and update the docs for 3.16... i don't have energy for that but if someone has, we could probably do it (tags will have to be done by maintainers, of course...)

[mergify]

Merge Queue Status

✅ The pull request has been merged at 9f85732

This pull request spent 1 hour 58 minutes 9 seconds in the queue, including 1 hour 47 minutes 2 seconds running CI.
The checks were run on draft #11400.

Required conditions to merge

• #approved-reviews-by >= 2 [🛡 GitHub branch protection]
  • Don't use lists in footnotes #11378
• #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
  • Don't use lists in footnotes #11378
• #review-threads-unresolved = 0 [🛡 GitHub branch protection]
  • Don't use lists in footnotes #11378
• any of [🛡 GitHub branch protection]:
  • check-success = Doctest Cabal
  • check-neutral = Doctest Cabal
  • check-skipped = Doctest Cabal
• any of [🛡 GitHub branch protection]:
  • check-success = Meta checks
  • check-neutral = Meta checks
  • check-skipped = Meta checks
• any of [🛡 GitHub branch protection]:
  • check-success = docs/readthedocs.org:cabal
  • check-neutral = docs/readthedocs.org:cabal
  • check-skipped = docs/readthedocs.org:cabal
• any of [🛡 GitHub branch protection]:
  • check-success = Validate post job
  • check-neutral = Validate post job
  • check-skipped = Validate post job
• any of [🛡 GitHub branch protection]:
  • check-success = fourmolu
  • check-neutral = fourmolu
  • check-skipped = fourmolu
• any of [🛡 GitHub branch protection]:
  • check-success = hlint
  • check-neutral = hlint
  • check-skipped = hlint
• any of [🛡 GitHub branch protection]:
  • check-success = Bootstrap post job
  • check-neutral = Bootstrap post job
  • check-skipped = Bootstrap post job
• any of [🛡 GitHub branch protection]:
  • check-success = whitespace
  • check-neutral = whitespace
  • check-skipped = whitespace
• any of [🛡 GitHub branch protection]:
  • check-success = Check sdist post job
  • check-neutral = Check sdist post job
  • check-skipped = Check sdist post job
• any of [🛡 GitHub branch protection]:
  • check-success = Changelogs
  • check-neutral = Changelogs
  • check-skipped = Changelogs