stdlib: Update shell docs render

erlang · Oct 17, 2024 · 67bec05 · 67bec05
1 parent f3f5872
commit 67bec05
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/lib/stdlib/test/shell_docs_SUITE_data/file.docs_v1 b/lib/stdlib/test/shell_docs_SUITE_data/file.docs_v1
diff --git a/lib/stdlib/test/shell_docs_SUITE_data/kernel_file_io_device_0_type.txt b/lib/stdlib/test/shell_docs_SUITE_data/kernel_file_io_device_0_type.txt
@@ -1,5 +1,7 @@
 
-  [;1m-type io_device() :: pid() | fd().[0m
+  [;1m-type io_device() :: io_server() | fd().[0m
 
-  As returned by [;;4mopen/2[0m; [;;4mpid/0[0m is a process handling
-  I/O-protocols.
+  An IO device as returned by [;;4mopen/2[0m.
+
+  [;;4mio_server/0[0m is returned by default and [;;4mfd/0[0m is returned if the [;;4m[0m
+  [;;4mraw[0m option is given.
diff --git a/lib/stdlib/test/shell_docs_SUITE_data/kernel_file_io_server_0_type.txt b/lib/stdlib/test/shell_docs_SUITE_data/kernel_file_io_server_0_type.txt
@@ -0,0 +1,4 @@
+
+  [;1m-type io_server() :: pid().[0m
+
+  A process handling the I/O protocol.
diff --git a/lib/stdlib/test/shell_docs_SUITE_data/kernel_file_type.txt b/lib/stdlib/test/shell_docs_SUITE_data/kernel_file_type.txt
@@ -53,7 +53,9 @@ These types are documented in this module:
   [;1m          {eof, Offset :: integer()} |[0m
   [;1m          bof | cur | eof.[0m
 
-  [;1m-type io_device() :: pid() | fd().[0m
+  [;1m-type io_device() :: io_server() | fd().[0m
+
+  [;1m-type io_server() :: pid().[0m
 
   [;1m-type fd() :: file_descriptor().[0m
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@

		[;1m-type io_server() :: pid().[0m

		A process handling the I/O protocol.