File 0264-stdlib-Add-a-bit-of-internal-docs-to-shell... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0264-stdlib-Add-a-bit-of-internal-docs-to-shell_docs.patch of Package erlang (Revision c5e180b483b62ec3dcbec1868ff03c21)

Currently displaying revision c5e180b483b62ec3dcbec1868ff03c21 , Show latest

From 949ab5376110458c021024d8f53c9e16d580b9ea Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Wed, 20 Jan 2021 16:11:29 +0100
Subject: [PATCH 4/7] stdlib: Add a bit of internal docs to shell_docs

---
 lib/stdlib/src/shell_docs.erl | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/lib/stdlib/src/shell_docs.erl b/lib/stdlib/src/shell_docs.erl
index 8fa9ec3675..9566f7c6a7 100644
--- a/lib/stdlib/src/shell_docs.erl
+++ b/lib/stdlib/src/shell_docs.erl
@@ -19,6 +19,17 @@
 %%
 -module(shell_docs).
 
+%% This module takes care of rendering and normalization of
+%% application/erlang+html style documentation.
+
+
+%% IMPORTANT!!
+%% When changing the rendering in the module, there are no tests as such
+%% that you do not break anything else. So you should use the function
+%% shell_docs_SUITE:render_all(Dir) to write all documentation to that
+%% folder and then you can use `diff -b` to see if you inadvertently changed
+%% something.
+
 -include_lib("kernel/include/eep48.hrl").
 
 -export([render/2, render/3, render/4, render/5]).
-- 
2.26.2

Places

File 0264-stdlib-Add-a-bit-of-internal-docs-to-shell_docs.patch of Package erlang (Revision c5e180b483b62ec3dcbec1868ff03c21)

Places