[commit: ghc] wip/az-annotations-ghc-8.8, wip/codeowners-parser: docs: change meta-variable of -interactive-print from expr to name (59d622d)
git at git.haskell.org
git at git.haskell.org
Mon Feb 4 11:30:32 UTC 2019
Repository : ssh://git@git.haskell.org/ghc
On branches: wip/az-annotations-ghc-8.8,wip/codeowners-parser
Link : http://ghc.haskell.org/trac/ghc/changeset/59d622d7f1a982e5f24bb0eb8e72121d3ef2270c/ghc
>---------------------------------------------------------------
commit 59d622d7f1a982e5f24bb0eb8e72121d3ef2270c
Author: Zejun Wu <watashi at fb.com>
Date: Wed Jan 30 17:35:50 2019 -0800
docs: change meta-variable of -interactive-print from expr to name
`-interactive-print` doesn't accept **expr** as `-e` or `:def` does. It must
be a qualified or unqualified **name** in scope.
>---------------------------------------------------------------
59d622d7f1a982e5f24bb0eb8e72121d3ef2270c
docs/users_guide/ghci.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/users_guide/ghci.rst b/docs/users_guide/ghci.rst
index f468e80..05b64f9 100644
--- a/docs/users_guide/ghci.rst
+++ b/docs/users_guide/ghci.rst
@@ -1181,20 +1181,20 @@ IO ()``, and it works by converting the value to ``String`` using ``show``.
This is not ideal in certain cases, like when the output is long, or
contains strings with non-ascii characters.
-The :ghc-flag:`-interactive-print ⟨expr⟩` flag allows to specify any function
+The :ghc-flag:`-interactive-print ⟨name⟩` flag allows to specify any function
of type ``C a => a -> IO ()``, for some constraint ``C``, as the function for
printing evaluated expressions. The function can reside in any loaded module or
any registered package, but only when it resides in a registered package will
it survive a :ghci-cmd:`:cd`, :ghci-cmd:`:add`, :ghci-cmd:`:load`,
:ghci-cmd:`:reload` or, :ghci-cmd:`:set`.
-.. ghc-flag:: -interactive-print ⟨expr⟩
+.. ghc-flag:: -interactive-print ⟨name⟩
:shortdesc: :ref:`Select the function to use for printing evaluated
expressions in GHCi <ghci-interactive-print>`
:type: dynamic
:category:
- Set the function used by GHCi to print evaluation results. Expression
+ Set the function used by GHCi to print evaluation results. Given name
must be of type ``C a => a -> IO ()``.
As an example, suppose we have following special printing module: ::
@@ -1224,7 +1224,7 @@ will start an interactive session where values with be printed using
A custom pretty printing function can be used, for example, to format
tree-like and nested structures in a more readable way.
-The :ghc-flag:`-interactive-print ⟨expr⟩` flag can also be used when running
+The :ghc-flag:`-interactive-print ⟨name⟩` flag can also be used when running
GHC in ``-e mode``:
.. code-block:: none
More information about the ghc-commits
mailing list