File 0285-Use-c-.-c-in-xml-docs-instead-of.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0285-Use-c-.-c-in-xml-docs-instead-of.patch of Package erlang (Revision a95c38533dd94a5c195230b3b146d029)

Currently displaying revision a95c38533dd94a5c195230b3b146d029 , Show latest

From 7909279e24330bfa5687bbd47d340b85a81b20b9 Mon Sep 17 00:00:00 2001
From: "Paulo F. Oliveira" <paulo.ferraz.oliveira@gmail.com>
Date: Tue, 8 Aug 2023 12:41:27 +0100
Subject: [PATCH] Use <c>...</c> (in xml docs) instead of `...`

The former renders proper HTML, the latter renders actual backticks.
---
 lib/stdlib/doc/src/proc_lib.xml             | 2 +-
 system/doc/reference_manual/expressions.xml | 2 +-
 system/doc/reference_manual/typespec.xml    | 4 ++--
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/lib/stdlib/doc/src/proc_lib.xml b/lib/stdlib/doc/src/proc_lib.xml
index a064c8341e..b3d4fef41c 100644
--- a/lib/stdlib/doc/src/proc_lib.xml
+++ b/lib/stdlib/doc/src/proc_lib.xml
@@ -458,7 +458,7 @@ init(Parent) ->
 <note>
 
 If the started process gets killed or crashes with a reason
- that is not `normal`, the process link will kill the calling
+ that is not <c>normal</c>, the process link will kill the calling
 process so this function does not return,
 unless the calling process traps exits.
 For example, if this function times out it will kill
diff --git a/system/doc/reference_manual/expressions.xml b/system/doc/reference_manual/expressions.xml
index 6b3ba96b6b..0d1fb61d17 100644
--- a/system/doc/reference_manual/expressions.xml
+++ b/system/doc/reference_manual/expressions.xml
@@ -566,7 +566,7 @@ end]]></code>
 
 Finally, let us assume that <c>a()</c> returns
 <c>-1</c>. Because <c>true = A >= 0</c> uses the match operator
- `=`, a <c>{badmatch,false}</c> run-time error occurs when the
+ <c>=</c>, a <c>{badmatch,false}</c> run-time error occurs when the
 expression fails to match the pattern.
 
 The example can be written in a less succient way using nested
diff --git a/system/doc/reference_manual/typespec.xml b/system/doc/reference_manual/typespec.xml
index 8f3ba3b25a..9116f92828 100644
--- a/system/doc/reference_manual/typespec.xml
+++ b/system/doc/reference_manual/typespec.xml
@@ -91,14 +91,14 @@
 <marker id="dynamic"/>
 
 To facilitate <url href="https://en.wikipedia.org/wiki/Gradual_typing">
- gradual typing</url> of Erlang, the type `dynamic()` is provided.
+ gradual typing</url> of Erlang, the type <c>dynamic()</c> is provided.
 It is similar to
 <url href="https://docs.python.org/3/library/typing.html#the-any-type">Any</url>
 in Python,
 <url href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</url>
 in TypeScript and
 <url href="https://docs.hhvm.com/hack/built-in-types/dynamic">dynamic</url>
- in Hack. `any()` and `dynamic()` interact with
+ in Hack. <c>any()</c> and <c>dynamic()</c> interact with
 <url href="https://learnyousomeerlang.com/dialyzer#success-typing">success typing</url>
 the same way, so Dialyzer doesn't distinguish between them.
 
-- 
2.35.3

Places

File 0285-Use-c-.-c-in-xml-docs-instead-of.patch of Package erlang (Revision a95c38533dd94a5c195230b3b146d029)

Places