Skip to content
Snippets Groups Projects

users-guide: Clarify language extension documentation

Closed Ben Gamari requested to merge wip/T23895 into master
1 unresolved thread

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.
  • eliminate redundant implication information from short descriptions.

Fixes #23895 (closed).

Edited by Ben Gamari

Merge request reports

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
4 4 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5 5
6 6 .. extension:: ExplicitNamespaces
7 :shortdesc: Enable using the keyword ``type`` to specify the namespace of
7 :shortdesc: Allow use of the keyword ``type`` to specify the namespace of
8 8 entries in imports and exports (:ref:`explicit-namespaces`).
  • Adam Gundry
  • Adam Gundry
  • Adam Gundry
  • Thanks for taking care of this @bgamari. I spotted a few small things to polish, but it would be great to land this.

  • assigned to @bgamari

  • Ben Gamari added 743 commits

    added 743 commits

    Compare with previous version

  • Ben Gamari approved this merge request

    approved this merge request

  • Ben Gamari assigned to @marge-bot and unassigned @bgamari

    assigned to @marge-bot and unassigned @bgamari

  • I will attempt to batch this MR (!12413 (closed))...

  • Batch MR !12413 (closed) failed: CI failed! I will retry later...

  • I will attempt to batch this MR (!12414 (closed))...

  • closed

  • Please register or sign in to reply
    Loading