[Git][ghc/ghc][master] 3 commits: users guide: Add glossary

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
0451bdc9 by Ben Gamari at 2023-05-16T21:31:40-04:00
users guide: Add glossary

Currently this merely explains the meaning of "technology preview" in
the context of released features.

- - - - -
0ba52e4e by Ben Gamari at 2023-05-16T21:31:40-04:00
Update glossary.rst
- - - - -
3d23060c by Ben Gamari at 2023-05-16T21:31:40-04:00
Use glossary directive
- - - - -


2 changed files:

- + docs/users_guide/glossary.rst
- docs/users_guide/index.rst


Changes:

=====================================
docs/users_guide/glossary.rst
=====================================
@@ -0,0 +1,13 @@
+Glossary
+========
+
+.. glossary::
+    technology preview
+
+      GHC will occassionally ship features advertised as being in a *technology
+      preview* state. Such features are generally opt-in in nature (e.g. new
+      language extensions) and may have various shortcomings. These may include
+      known bugs (which we will try to document), lacking optimisation, and
+      unhandled interactions with other language features. As such, behavior
+      of such features may change in the future. However, we do expect features
+      to converge to non-preview state over the course of a few GHC major releases.


=====================================
docs/users_guide/index.rst
=====================================
@@ -27,6 +27,7 @@ Contents:
    wasm
    bugs
    eventlog-formats
+   glossary
    editing-guide
 
 



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/47a5815070a8ebf4ce1e00de0a44863fd9c1fb84...3d23060c6f088e786b95865b9ac1ca84e97c1e6d

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/47a5815070a8ebf4ce1e00de0a44863fd9c1fb84...3d23060c6f088e786b95865b9ac1ca84e97c1e6d
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/20230516/8f2546b8/attachment-0001.html>