diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/9.2.1-notes.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/users_guide/9.2.1-notes.rst b/docs/users_guide/9.2.1-notes.rst index 3b0022fb8a..131f694f6b 100644 --- a/docs/users_guide/9.2.1-notes.rst +++ b/docs/users_guide/9.2.1-notes.rst @@ -165,6 +165,19 @@ Runtime system is returned is controlled by the :rts-flag:`-Fd ⟨factor⟩`. Memory return is triggered by consecutive idle collections. +Template Haskell +~~~~~~~~~~~~~~~~ + +- There are two new functions ``putDoc`` and ``getDoc``, which allow Haddock + documentation to be attached and read from module headers, declarations, + function arguments, class instances and family instances. + These functions are quite low level, so the ``withDecDoc`` function provides + a more ergonomic interface for this. Similarly ``funD_doc``, ``dataD_doc`` + and friends provide an easy way to document functions and constructors + alongside their arguments simultaneously. :: + + $(withDecsDoc "This does good things" [d| foo x = 42 |]) + ``ghc-prim`` library ~~~~~~~~~~~~~~~~~~~~ |