File 2628-shell-Polish-shell-formatting-docs.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2628-shell-Polish-shell-formatting-docs.patch of Package erlang (Revision a95c38533dd94a5c195230b3b146d029)

Currently displaying revision a95c38533dd94a5c195230b3b146d029 , Show latest

From 8c25c73fbc999cba16e4b129e812d0b5801a5f57 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Thu, 4 Jan 2024 09:57:19 +0100
Subject: [PATCH 08/11] shell: Polish shell formatting docs

---
 erts/doc/src/tty.xml         | 4 ++++
 lib/stdlib/doc/src/shell.xml | 7 ++++---
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/erts/doc/src/tty.xml b/erts/doc/src/tty.xml
index 054e9ab219..3a3e6719a4 100644
--- a/erts/doc/src/tty.xml
+++ b/erts/doc/src/tty.xml
@@ -177,6 +177,10 @@ erl</pre>
         <cell align="left" valign="middle">Fetch previous line from the history
           buffer</cell>
       </row>
+      <row>
+        <cell align="left" valign="middle">M-r</cell>
+        <cell align="left" valign="middle">Format current expression using <seemfa marker="stdlib:shell#format_shell_func/1">shell:format_shell_func/1</seemfa></cell>
+      </row>
       <row>
         <cell align="left" valign="middle">C-r</cell>
         <cell align="left" valign="middle">Enter search mode and then search backward in the shell history</cell>
diff --git a/lib/stdlib/doc/src/shell.xml b/lib/stdlib/doc/src/shell.xml
index 59beb02485..996ef9c0be 100644
--- a/lib/stdlib/doc/src/shell.xml
+++ b/lib/stdlib/doc/src/shell.xml
@@ -1046,10 +1046,11 @@ q                 - quit erlang
       <name name="format_shell_func" arity="1" since="OTP 27.0"/>
       <fsummary>Set the formatting function for submitted shell commands.</fsummary>
       <desc>
-        <p>Can be used to set the formatting of the Erlang shell output. This have an effect
+        <p>Can be used to set the formatting of the Erlang shell output. This has an effect
         on commands that have been submitted, and how it is saved in history. Or if the
-        formatting hotkey is pressed while editing an expression (Alt-f by default). You can specify a Mod:Func/1 that
-        expects the whole expression as a string and returns a formatted expressions as a string.
+        formatting hotkey is pressed while editing an expression (Alt-r by default). You
+        can specify a <c>Mod:Func/1</c> that expects the whole expression as a string and
+        returns a formatted expressions as a string.
         See <seeapp marker="STDLIB_app#format_shell_func"><c>stdlib app config</c></seeapp>
         for how to set it before shell started.</p>
         <p>If instead a string is provided, it will be used as a shell command.
-- 
2.35.3

Places

File 2628-shell-Polish-shell-formatting-docs.patch of Package erlang (Revision a95c38533dd94a5c195230b3b146d029)

Places