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 thanNoImplicitPrelude
). - 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).
Merge request reports
Activity
added 1 commit
- 49c9b318 - users-guide: Clarify language extension documentation
mentioned in issue #23895 (closed)
added 1 commit
- 338e08ab - users-guide: Clarify language extension documentation
added 42 commits
-
338e08ab...b8e4fe23 - 41 commits from branch
master
- d9837b2a - users-guide: Clarify language extension documentation
-
338e08ab...b8e4fe23 - 41 commits from branch
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`). changed this line in version 5 of the diff
- Resolved by Ben Gamari
- Resolved by Ben Gamari
- Resolved by Ben Gamari
Thanks for taking care of this @bgamari. I spotted a few small things to polish, but it would be great to land this.
added documentation label
assigned to @bgamari
added 743 commits
-
d9837b2a...1324b862 - 742 commits from branch
master
- cd488d38 - users-guide: Clarify language extension documentation
-
d9837b2a...1324b862 - 742 commits from branch
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))...
Merged in 6e18ce2b