Fix typos in *.hs files

[philderbeast]

Follow on from #10603, using typos --write-changes over *.hs files initially and then manually fixing any other typos found but with ambiguous fixes.

Note

I chose the A template to err on the side of caution. Almost all changes are to haddock comments.

There is one exported function name that this changes:

module Distribution.PackageDescription.Check.Warning
  (
...
-  , extractCheckExplantion
+  , extractCheckExplanation
...
  ) where

However this is in a module that is not exported from Cabal:

cabal/Cabal/Cabal.cabal

Lines 326 to 345 in 1f52963

	other-modules:
	Distribution.Backpack.PreExistingComponent
	Distribution.Backpack.ReadyComponent
	Distribution.Backpack.MixLink
	Distribution.Backpack.ModuleScope
	Distribution.Backpack.UnifyM
	Distribution.Backpack.Id
	Distribution.Utils.UnionFind
	Distribution.Compat.Async
	Distribution.Compat.CopyFile
	Distribution.Compat.GetShortPathName
	Distribution.Compat.SnocList
	Distribution.GetOpt
	Distribution.Lex
	Distribution.PackageDescription.Check.Common
	Distribution.PackageDescription.Check.Conditional
	Distribution.PackageDescription.Check.Monad
	Distribution.PackageDescription.Check.Paths
	Distribution.PackageDescription.Check.Target
	Distribution.PackageDescription.Check.Warning

---

Template Α: This PR modifies behaviour or interface

Include the following checklist in your PR:

• Patches conform to the coding conventions.
• Any changes that could be relevant to users have been recorded in the changelog.
  • Is the change significant? If so, remember to add significance: significant in the changelog file.
• The documentation has been updated, if necessary.
• Manual QA notes have been included.
• Tests have been added. (Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!)

[ulysses4ever]

TWIMC: there's one API change

[philderbeast]

TWIMC: there's one API change

@geekosaur, what does your API checking, of #10259, have say about this change¹?

Footnotes

1. I will try the API change checks locally, make generate-api, make check-api and make update-api. ↩

[geekosaur]

I haven't checked because last time I poked at the PR I was unexpectedly finding references to cabal 3.15 (i.e. master) in the API files. I think that's just because I failed to remove dist-* first, but if not then we have a problem on 3.12 already and it may be a big one.

[geekosaur]

That appears to be the only one (the others are either let/where bindings or not exported). We probably want to give this one a miss, or start a deprecation on the misspelled one.

[Kleidukos]

@geekosaur is right, this is a good moment to try it out.

@philderbeast please could you create a wiki page based on this template? https://github.com/haskell/cabal/wiki/Deprecation-Process

You don't have to do every step by yourself. Especially feel free to rope in people, or mention it on Matrix so that it may be included in this week's agenda.

[philderbeast]

@Kleidukos we can skip the deprecation process for this rename as extractCheckExplantion was exported from Distribution.PackageDescription.Check.Warning in other-modules and @geekosaur confirms this in #10613 (comment).

[Kleidukos]

Sorry, then yeah nevermind. :)

[ulysses4ever]

My bad: I jumped the gun with calling it an API change...

[philderbeast]

My bad: I jumped the gun with calling it an API change...

All good. You flagged that it might be before I'd edited the PR description to say that the module is in other-modules. Better to be safe than sorry with API changes.

[philderbeast]

Label merge+no rebase is necessary when the pull request is from an organisation.