[Git][ghc/ghc][wip/T23895] users-guide: Clarify language extension documentation

[Ben Gamari (@bgamari)]

Ben Gamari pushed to branch wip/T23895 at Glasgow Haskell Compiler / GHC


Commits:
338e08ab by Ben Gamari at 2023-09-13T15:33:03-04:00
users-guide: Clarify language extension documentation

Over the years the users guide's language extension documentation has
gone through quite a few refactorings. In the process some of the
descriptions have been rendered non-sensical. For instance, the
description of `NoImplicitPrelude` actually describes the semantics of
`ImplicitPrelude`.

To fix this we:

 * ensure that all extensions are named in their "positive" sense (e.g.
   `ImplicitPrelude` rather than `NoImplicitPrelude`).
 * rework the documentation to avoid flag-oriented wording
   like "enable" and "disable"
 * ensure that the polarity of the documentation is consistent with
   reality.

Fixes #23895.

- - - - -


30 changed files:

- docs/users_guide/exts/applicative_do.rst
- docs/users_guide/exts/arrows.rst
- docs/users_guide/exts/binary_literals.rst
- docs/users_guide/exts/constrained_class_methods.rst
- docs/users_guide/exts/constraint_kind.rst
- docs/users_guide/exts/data_kinds.rst
- docs/users_guide/exts/default_signatures.rst
- docs/users_guide/exts/derive_any_class.rst
- docs/users_guide/exts/deriving_extra.rst
- docs/users_guide/exts/deriving_strategies.rst
- docs/users_guide/exts/deriving_via.rst
- docs/users_guide/exts/disambiguate_record_fields.rst
- docs/users_guide/exts/empty_case.rst
- docs/users_guide/exts/existential_quantification.rst
- docs/users_guide/exts/explicit_forall.rst
- docs/users_guide/exts/explicit_namespaces.rst
- docs/users_guide/exts/extended_literals.rst
- docs/users_guide/exts/ffi.rst
- docs/users_guide/exts/field_selectors.rst
- docs/users_guide/exts/functional_dependencies.rst
- docs/users_guide/exts/gadt.rst
- docs/users_guide/exts/gadt_syntax.rst
- docs/users_guide/exts/generalised_list_comprehensions.rst
- docs/users_guide/exts/generics.rst
- docs/users_guide/exts/hex_float_literals.rst
- docs/users_guide/exts/implicit_parameters.rst
- docs/users_guide/exts/import_qualified_post.rst
- docs/users_guide/exts/impredicative_types.rst
- docs/users_guide/exts/instances.rst
- docs/users_guide/exts/kind_signatures.rst


The diff was not included because it is too large.


View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/338e08ab9fae79a655f527f5eb76db92fcaafd1b

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/338e08ab9fae79a655f527f5eb76db92fcaafd1b
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20230913/0bd3e4ea/attachment-0001.html>