File 0143-Add-a-link-to-the-Reference-Manual-from-th... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0143-Add-a-link-to-the-Reference-Manual-from-the-example-.patch of Package erlang

From b8d4bd38e343488b5e8539f913650b150cab3ade Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Wed, 17 May 2017 06:24:02 +0200
Subject: [PATCH 1/2] Add a link to the Reference Manual from the example page

When doing a Google search for "bit syntax", you could end up
on the programming examples page about bit syntax. The example
page has some reference material, but is far from complete.

Therefore, add a link to the page about bit syntax in the
Reference Manual.

https://bugs.erlang.org/browse/ERL-387
---
 system/doc/programming_examples/bit_syntax.xml | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/system/doc/programming_examples/bit_syntax.xml b/system/doc/programming_examples/bit_syntax.xml
index 0af295b7b..03645bba1 100644
--- a/system/doc/programming_examples/bit_syntax.xml
+++ b/system/doc/programming_examples/bit_syntax.xml
@@ -32,6 +32,8 @@
 
 <section>
 <title>Introduction</title>
+ The complete specification for the bit syntax appears in the
+ <seealso marker="doc/reference_manual:expressions#bit_syntax">Reference Manual</seealso>.
 In Erlang, a Bin is used for constructing binaries and matching
 binary patterns. A Bin is written with the following syntax:
 <code type="none"><![CDATA[
@@ -165,8 +167,9 @@ end.]]></code>
 separated by hyphens.
 <taglist>
 <tag>Type</tag>
- <item>The type can be <c>integer</c>, <c>float</c>, or
- <c>binary</c>.</item>
+ <item>The most commonly used types are <c>integer</c>, <c>float</c>, and <c>binary</c>.
+ See <seealso marker="doc/reference_manual:expressions#bit_syntax">Bit Syntax Expressions in the Reference Manual</seealso> for a complete description.
+</item>
 <tag>Signedness</tag>
 <item>The signedness specification can be either <c>signed</c>
 or <c>unsigned</c>. Notice that signedness only matters for
-- 
2.13.0

Places

File 0143-Add-a-link-to-the-Reference-Manual-from-the-example-.patch of Package erlang

Places