users-guide: Document multi-line DEPRECATED pragmas
authorBen Gamari <bgamari.foss@gmail.com>
Mon, 12 Jun 2017 21:00:55 +0000 (17:00 -0400)
committerBen Gamari <ben@smart-cactus.org>
Mon, 12 Jun 2017 21:00:56 +0000 (17:00 -0400)
Fixes #13791.

[skip ci]

Test Plan: Read it

Reviewers: austin

Subscribers: rwbarton, thomie

GHC Trac Issues: #13791

Differential Revision: https://phabricator.haskell.org/D3639

docs/users_guide/glasgow_exts.rst

index 20312eb..e4da54e 100644 (file)
@@ -12598,6 +12598,12 @@ are two ways of using these pragmas.
    both are in scope. If both are in scope, there is currently no way to
    specify one without the other (c.f. fixities :ref:`infix-tycons`).
 
+Also note that the argument to ``DEPRECATED`` and ``WARNING`` can also be a list
+of strings, in which case the strings will be presented on separate lines in the
+resulting warning message, ::
+
+    {-# DEPRECATED foo, bar ["Don't use these", "Use gar instead"] #-}
+
 Warnings and deprecations are not reported for (a) uses within the
 defining module, (b) defining a method in a class instance, and (c) uses
 in an export list. The latter reduces spurious complaints within a