diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2023-05-01 11:52:10 -0400 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2023-05-16 21:31:40 -0400 |
| commit | 0451bdc9aa2db80438d715ba2544b10bcdc34e14 (patch) | |
| tree | ab9d811f88b047ba3dd984181aac28b6d0e38465 | |
| parent | 47a5815070a8ebf4ce1e00de0a44863fd9c1fb84 (diff) | |
| download | haskell-0451bdc9aa2db80438d715ba2544b10bcdc34e14.tar.gz | |
users guide: Add glossary
Currently this merely explains the meaning of "technology preview" in
the context of released features.
| -rw-r--r-- | docs/users_guide/glossary.rst | 18 | ||||
| -rw-r--r-- | docs/users_guide/index.rst | 1 |
2 files changed, 19 insertions, 0 deletions
diff --git a/docs/users_guide/glossary.rst b/docs/users_guide/glossary.rst new file mode 100644 index 0000000000..6c036f8093 --- /dev/null +++ b/docs/users_guide/glossary.rst @@ -0,0 +1,18 @@ +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). + + + Expectation that work will continue -- unlikely to just disappear + Doesn’t implement all features (best to enumerate: TH…) + A list of known bugs/shortcomings listed here (wiki page) + Isn’t optimized (produces suboptimal code) + Behavior may change in the future, although we will try to document such changes + + + diff --git a/docs/users_guide/index.rst b/docs/users_guide/index.rst index 15274dcc71..4bdbf13eee 100644 --- a/docs/users_guide/index.rst +++ b/docs/users_guide/index.rst @@ -27,6 +27,7 @@ Contents: wasm bugs eventlog-formats + glossary editing-guide |