[インデックス 15907] ファイルの概要
このコミットは、Go言語の公式仕様書である doc/go_spec.html
に対する変更です。具体的には、仕様書内のリンクの形式と用語の統一性を改善することを目的としています。
コミット
commit 462a17e0f3ac22174cba34dbfb488695f4ddfcd0
Author: Robert Griesemer <gri@golang.org>
Date: Fri Mar 22 15:36:04 2013 -0700
spec: remove most §links for the now more common in-text links
Also:
- more consistenly use "xxx" statement rather than <code>xxx</code> statement
- fix/remove unnecessary links
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/7821050
GitHub上でのコミットページへのリンク
https://github.com/golang/go/commit/462a17e0f3ac22174cba34dbfb488695f4ddfcd0
元コミット内容
このコミットの元の内容は以下の通りです。
spec: remove most §links for the now more common in-text links
- 仕様書から、セクション番号を示す
§
記号を用いたリンクのほとんどを削除し、より一般的なインテキスト(文中に埋め込まれた)リンクに置き換える。
- 仕様書から、セクション番号を示す
Also:
more consistenly use "xxx" statement rather than <code>xxx</code> statement
<code>xxx</code> statement
のようなHTMLタグを用いた表現ではなく、より一貫して"xxx" statement
の形式を使用する。
fix/remove unnecessary links
- 不要なリンクを修正または削除する。
変更の背景
このコミットの背景には、Go言語の公式仕様書 doc/go_spec.html
の可読性とメンテナンス性の向上が挙げられます。
初期の技術文書では、特定のセクションへの参照を示すために §
記号とセクション番号を組み合わせた形式(例: §<a href="#Slices">Slices</a>
)が用いられることがありました。これは、紙媒体の書籍やPDFのような固定レイアウトの文書では有効な参照方法ですが、Webベースのドキュメントにおいては、より自然な文脈でリンクが埋め込まれている「インテキストリンク」の方がユーザーエクスペリエンスが向上します。
また、技術文書においては、特定のキーワードやコード片を強調するために <code>
タグを使用することが一般的ですが、文法的な要素(例: "statement")を指す場合には、必ずしもコードとして強調する必要はありません。このコミットでは、このような文法的な要素の記述において、<code>
タグの使用を避け、よりプレーンな引用符 " "
を用いることで、表現の統一性を図っています。
さらに、時間の経過とともに仕様書の内容が更新される中で、古くなったり、もはや必要でなくなったリンクが存在する可能性があります。これらの不要なリンクを整理することで、仕様書の正確性と簡潔性を保つ狙いがあります。
これらの変更は、Go言語の仕様書が、開発者にとってより理解しやすく、参照しやすい高品質なドキュメントであることを保証するための継続的な取り組みの一環と言えます。
前提知識の解説
このコミットを理解するためには、以下の前提知識が役立ちます。
- Go言語仕様 (Go Language Specification):
- Go言語の公式な文法、セマンティクス、および標準ライブラリの動作を定義する文書です。Go言語の「憲法」とも言える存在で、コンパイラの実装者や言語の深い理解を目指す開発者にとって最も重要な情報源です。
- 通常、HTML形式で提供され、Webブラウザで閲覧できるように構成されています。
- HTML (HyperText Markup Language):
- Webページを作成するための標準的なマークアップ言語です。このコミットで変更されている
doc/go_spec.html
はHTMLファイルであり、その構造や要素(例:<a>
タグ、<code>
タグ、<p>
タグなど)の知識が必要です。 <a>
タグはハイパーリンクを作成するために使用され、href
属性でリンク先を指定します。<code>
タグは、コンピュータのコード片を示すために使用され、通常は等幅フォントで表示されます。
- Webページを作成するための標準的なマークアップ言語です。このコミットで変更されている
- インテキストリンク (In-text links):
- 文書の本文中に自然な形で埋め込まれたハイパーリンクのことです。例えば、「Go言語のスライスについて」のように、文脈の中でキーワードが直接リンクになっている形式です。
- これに対し、従来の
§links
は、セクション番号を明示的に示すことで、特定のセクションへの参照を強調する形式でした。
- ドキュメントの統一性 (Documentation Consistency):
- 技術文書において、用語、書式、表現方法などを一貫させることは非常に重要です。統一性があることで、読者は混乱することなく情報を吸収でき、文書全体の品質と信頼性が向上します。
- このコミットでは、リンクの形式と特定の文法要素の表現方法の統一を図っています。
- Gitのdiff形式:
- コミットログに含まれる
diff --git a/doc/go_spec.html b/doc/go_spec.html
以降のセクションは、Gitの差分表示形式です。 --- a/doc/go_spec.html
は変更前のファイル、+++ b/doc/go_spec.html
は変更後のファイルを示します。- 行頭の
-
は削除された行、+
は追加された行を示します。これにより、具体的な変更内容を視覚的に把握できます。
- コミットログに含まれる
技術的詳細
このコミットは、Go言語仕様書のHTMLファイル doc/go_spec.html
の内容を直接編集することで、以下の技術的な変更を加えています。
-
§
記号を用いたセクションリンクの削除とインテキストリンクへの移行:- 変更前:
<a href="#Slices">Slices</a>
の前に§
が付与され、セクション番号が明示されていました(例:§<a href="#Slices">Slices</a>
)。 - 変更後:
§
記号とそれに続くセクション番号の記述が削除され、リンクテキスト自体が文脈に溶け込む形で表現されています(例:<a href="#Slices"><i>slicing</i></a>
)。これにより、読者はより自然な形で関連セクションへ移動できるようになります。これは、Webドキュメントにおける一般的なナビゲーションパターンに合わせたものです。 - 例:
- (§<a href=\"#Slices\">Slices</a>).
が+ <a href=\"#Slices\"><i>slicing</i></a> a new one from the original slice.
に変更。- (§<a href=\"#Comparison_operators\">Comparison operators</a>)
が+ <a href=\"#Comparison_operators\">comparison operators</a>
に変更。
- 変更前:
-
<code>
タグの使用の一貫性向上:- 変更前: 文法的な要素やキーワードを
<code>
タグで囲んで強調している箇所がありました(例:<code>xxx</code> statement
)。 - 変更後: これらの箇所が引用符
" "
で囲まれたプレーンなテキストに置き換えられています(例:"xxx" statement
)。これは、<code>
タグが主にコードスニペットや変数名、関数名など、プログラムコードに直接関連する要素に使用されるべきであるという慣習に基づいています。文法的な概念は、コードそのものではないため、引用符で十分と判断されたと考えられます。 - 例:
- <code>xxx</code> statement
が+ "xxx" statement
に変更。- <code>if</code>, <code>for</code>, or <code>switch</code> statements
が+ <a href=\"#If_statements\">\"if\"</a>, <a href=\"#For_statements\">\"for\"</a>, or <a href=\"#Switch_statements\">\"switch\"</a> statements
に変更。ここでは、さらに各ステートメントへのリンクも追加されています。
- 変更前: 文法的な要素やキーワードを
-
不要なリンクの修正/削除:
- コミットメッセージに明示されている通り、文脈上不要になったり、冗長になったりしたリンクが削除または修正されています。これは、ドキュメントの簡潔性を保ち、読者の混乱を避けるためのメンテナンス作業です。
これらの変更は、HTMLの構造とセマンティクスをより適切に利用し、Go言語仕様書という重要な技術文書の品質を向上させるための細かな調整です。
コアとなるコードの変更箇所
変更はすべて doc/go_spec.html
ファイル内で行われています。以下に、変更の性質を示す代表的な差分をいくつか示します。
--- a/doc/go_spec.html
+++ b/doc/go_spec.html
@@ -639,8 +639,8 @@ expressions</a>.
<p>
A type determines the set of values and operations specific to values of that
type. A type may be specified by a
-(possibly <a href="§#Qualified_identifiers">qualified</a>) <i>type name</i>
-(§<a href="§#Type_declarations">Type declarations</a>) or a <i>type literal</i>,
+(possibly <a href="#Qualified_identifiers">qualified</a>)
+<a href="#Type_declarations"><i>type name</i></a> or a <i>type literal</i>,
which composes a new type from previously declared types.
</p>
@@ -866,8 +866,8 @@ distinct arrays always represent distinct storage.
The array underlying a slice may extend past the end of the slice.
The <i>capacity</i> is a measure of that extent: it is the sum of
the length of the slice and the length of the array beyond the slice;
-a slice of length up to that capacity can be created by `slicing\' a new
-one from the original slice (§<a href="§#Slices">Slices</a>).
+a slice of length up to that capacity can be created by
+<a href="#Slices"><i>slicing</i></a> a new one from the original slice.
The capacity of a slice <code>a</code> can be discovered using the
built-in function <a href="#Length_and_capacity"><code>cap(a)</code></a>.
</p>
@@ -1571,8 +1571,9 @@ declarations.
<p>
Labels are declared by <a href="#Labeled_statements">labeled statements</a> and are
-used in the <code>break</code>, <code>continue</code>, and <code>goto</code>
-statements (§<a href="§#Break_statements">Break statements</a>, §<a href="§#Continue_statements">Continue statements</a>, §<a href="§#Goto_statements">Goto statements</a>).
+used in the <a href="#Break_statements">"break"</a>,
+<a href="#Continue_statements">"continue"</a>, and
+<a href="#Goto_statements">"goto"</a> statements.
It is illegal to define a label that is never used.
In contrast to other identifiers, labels are not block scoped and do
not conflict with identifiers that are not labels. The scope of a label
@@ -1939,9 +1940,11 @@ a, a := 1, 2 // illegal: double declaration of a or
<p>
Short variable declarations may appear only inside functions.
-In some contexts such as the initializers for <code>if</code>,
-<code>for</code>, or <code>switch</code> statements,
-they can be used to declare local temporary variables (§<a href="§#Statements">Statements</a>).
+In some contexts such as the initializers for
+<a href="#If_statements">"if"</a>,
+<a href="#For_statements">"for"</a>, or
+<a href="#Switch_statements">"switch"</a> statements,
+they can be used to declare local temporary variables.
</p>
<h3 id="Function_declarations">Function declarations</h3>
コアとなるコードの解説
上記の差分は、コミットの意図を明確に示しています。
-
§
記号の削除とインテキストリンクへの変換:- 最初の差分では、
Type declarations
へのリンクが、以前は(§<a href="§#Type_declarations">Type declarations</a>)
のように§
記号とセクション名が併記されていましたが、変更後は<a href="#Type_declarations"><i>type name</i></a>
のように、リンクテキスト自体が文脈に溶け込む形になっています。これにより、読者はより自然な形で関連情報にアクセスできます。 - 同様に、
Slices
へのリンクも(§<a href="§#Slices">Slices</a>)
から<a href="#Slices"><i>slicing</i></a>
へと変更され、動詞の一部としてリンクが埋め込まれています。
- 最初の差分では、
-
<code>
タグから引用符への変更とリンクの追加:break
,continue
,goto
ステートメントに関する記述では、以前は<code>break</code>
,<code>continue</code>
,<code>goto</code>
のように<code>
タグで囲まれていましたが、変更後は"<a href="#Break_statements">"break"</a>"
,"<a href="#Continue_statements">"continue"</a>"
,"<a href="#Goto_statements">"goto"</a>"
のように、引用符で囲まれたテキストに各ステートメントへの直接リンクが追加されています。これは、文法的なキーワードをコードとしてではなく、引用されたテキストとして扱い、かつ読者がすぐにその定義に飛べるようにするための改善です。if
,for
,switch
ステートメントの初期化子に関する記述でも同様に、<code>
タグが削除され、各ステートメントへのリンクが追加されています。
これらの変更は、Go言語仕様書が単なる技術文書としてだけでなく、Webベースのインタラクティブなリソースとしての利便性を高めるためのものです。リンクの形式を統一し、用語の表現を洗練することで、読者はよりスムーズに情報を探索し、理解を深めることができるようになります。
関連リンク
- Go言語公式ウェブサイト: https://go.dev/
- Go言語仕様: https://go.dev/ref/spec (このコミットで変更された文書の最新版)
参考にした情報源リンク
- Gitの差分表示について: https://git-scm.com/docs/git-diff
- HTML
<a>
タグ: https://developer.mozilla.org/ja/docs/Web/HTML/Element/a - HTML
<code>
タグ: https://developer.mozilla.org/ja/docs/Web/HTML/Element/code - Go言語のコミット履歴 (GitHub): https://github.com/golang/go/commits/master
- Go言語のコードレビューシステム (Gerrit): https://go.dev/cl/ (コミットログにある
https://golang.org/cl/7821050
はGerritの変更リストへのリンクです)
[インデックス 15907] ファイルの概要
このコミットは、Go言語の公式仕様書である doc/go_spec.html
に対する変更です。具体的には、仕様書内のリンクの形式と用語の統一性を改善することを目的としています。
コミット
commit 462a17e0f3ac22174cba34dbfb488695f4ddfcd0
Author: Robert Griesemer <gri@golang.org>
Date: Fri Mar 22 15:36:04 2013 -0700
spec: remove most §links for the now more common in-text links
Also:
- more consistenly use "xxx" statement rather than <code>xxx</code> statement
- fix/remove unnecessary links
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/7821050
GitHub上でのコミットページへのリンク
https://github.com/golang/go/commit/462a17e0f3ac22174cba34dbfb488695f4ddfcd0
元コミット内容
このコミットの元の内容は以下の通りです。
spec: remove most §links for the now more common in-text links
- 仕様書から、セクション番号を示す
§
記号を用いたリンクのほとんどを削除し、より一般的なインテキスト(文中に埋め込まれた)リンクに置き換える。
- 仕様書から、セクション番号を示す
Also:
more consistenly use "xxx" statement rather than <code>xxx</code> statement
<code>xxx</code> statement
のようなHTMLタグを用いた表現ではなく、より一貫して"xxx" statement
の形式を使用する。
fix/remove unnecessary links
- 不要なリンクを修正または削除する。
変更の背景
このコミットの背景には、Go言語の公式仕様書 doc/go_spec.html
の可読性とメンテナンス性の向上が挙げられます。
初期の技術文書では、特定のセクションへの参照を示すために §
記号とセクション番号を組み合わせた形式(例: §<a href="#Slices">Slices</a>
)が用いられることがありました。これは、紙媒体の書籍やPDFのような固定レイアウトの文書では有効な参照方法ですが、Webベースのドキュメントにおいては、より自然な文脈でリンクが埋め込まれている「インテキストリンク」の方がユーザーエクスペリエンスが向上します。Web上のドキュメントでは、文脈に溶け込んだリンクが一般的であり、読者はよりスムーズに情報にアクセスできます。
また、技術文書においては、特定のキーワードやコード片を強調するために <code>
タグを使用することが一般的ですが、文法的な要素(例: "statement")を指す場合には、必ずしもコードとして強調する必要はありません。このコミットでは、このような文法的な要素の記述において、<code>
タグの使用を避け、よりプレーンな引用符 " "
を用いることで、表現の統一性を図っています。これは、<code>
タグがコードの断片やプログラミング言語のキーワードに限定して使用されるべきという、より厳密なセマンティックなHTMLの使用法に沿ったものです。
さらに、時間の経過とともに仕様書の内容が更新される中で、古くなったり、もはや必要でなくなったリンクが存在する可能性があります。これらの不要なリンクを整理することで、仕様書の正確性と簡潔性を保つ狙いがあります。
これらの変更は、Go言語の仕様書が、開発者にとってより理解しやすく、参照しやすい高品質なドキュメントであることを保証するための継続的な取り組みの一環と言えます。
前提知識の解説
このコミットを理解するためには、以下の前提知識が役立ちます。
- Go言語仕様 (Go Language Specification):
- Go言語の公式な文法、セマンティクス、および標準ライブラリの動作を定義する文書です。Go言語の「憲法」とも言える存在で、コンパイラの実装者や言語の深い理解を目指す開発者にとって最も重要な情報源です。
- 通常、HTML形式で提供され、Webブラウザで閲覧できるように構成されています。
- HTML (HyperText Markup Language):
- Webページを作成するための標準的なマークアップ言語です。このコミットで変更されている
doc/go_spec.html
はHTMLファイルであり、その構造や要素(例:<a>
タグ、<code>
タグ、<p>
タグなど)の知識が必要です。 <a>
タグはハイパーリンクを作成するために使用され、href
属性でリンク先を指定します。#
で始まるhref
は、同じHTMLドキュメント内の特定のIDを持つ要素へのアンカーリンクを示します。<code>
タグは、コンピュータのコード片を示すために使用され、通常は等幅フォントで表示されます。
- Webページを作成するための標準的なマークアップ言語です。このコミットで変更されている
- インテキストリンク (In-text links):
- 文書の本文中に自然な形で埋め込まれたハイパーリンクのことです。例えば、「Go言語のスライスについて」のように、文脈の中でキーワードが直接リンクになっている形式です。
- これに対し、従来の
§links
は、セクション番号を明示的に示すことで、特定のセクションへの参照を強調する形式でした。この§
記号は、学術論文や法律文書などでセクションや条項を示す際に用いられることがありますが、Webドキュメントではあまり一般的ではありません。
- ドキュメントの統一性 (Documentation Consistency):
- 技術文書において、用語、書式、表現方法などを一貫させることは非常に重要です。統一性があることで、読者は混乱することなく情報を吸収でき、文書全体の品質と信頼性が向上します。
- このコミットでは、リンクの形式と特定の文法要素の表現方法の統一を図っています。
- Gitのdiff形式:
- コミットログに含まれる
diff --git a/doc/go_spec.html b/doc/go_spec.html
以降のセクションは、Gitの差分表示形式です。 --- a/doc/go_spec.html
は変更前のファイル、+++ b/doc/go_spec.html
は変更後のファイルを示します。- 行頭の
-
は削除された行、+
は追加された行を示します。これにより、具体的な変更内容を視覚的に把握できます。
- コミットログに含まれる
技術的詳細
このコミットは、Go言語仕様書のHTMLファイル doc/go_spec.html
の内容を直接編集することで、以下の技術的な変更を加えています。
-
§
記号を用いたセクションリンクの削除とインテキストリンクへの移行:- 変更前:
<a href="#Slices">Slices</a>
の前に§
が付与され、セクション番号が明示されていました(例:§<a href="#Slices">Slices</a>
)。これは、紙媒体の文書における参照方法の名残と考えられます。 - 変更後:
§
記号とそれに続くセクション番号の記述が削除され、リンクテキスト自体が文脈に溶け込む形で表現されています(例:<a href="#Slices"><i>slicing</i></a>
)。これにより、読者はより自然な形で関連セクションへ移動できるようになります。これは、Webドキュメントにおける一般的なナビゲーションパターンに合わせたもので、ユーザーエクスペリエンスの向上に寄与します。 - 例:
- (§<a href=\"#Slices\">Slices</a>).
が+ <a href=\"#Slices\"><i>slicing</i></a> a new one from the original slice.
に変更。- (§<a href=\"#Comparison_operators\">Comparison operators</a>)
が+ <a href=\"#Comparison_operators\">comparison operators</a>
に変更。
- 変更前:
-
<code>
タグの使用の一貫性向上:- 変更前: 文法的な要素やキーワードを
<code>
タグで囲んで強調している箇所がありました(例:<code>xxx</code> statement
)。これは、コードとそうでないテキストの区別を曖昧にする可能性がありました。 - 変更後: これらの箇所が引用符
" "
で囲まれたプレーンなテキストに置き換えられています(例:"xxx" statement
)。これは、<code>
タグが主にコードスニペットや変数名、関数名など、プログラムコードに直接関連する要素に使用されるべきであるというHTMLのセマンティックな慣習に基づいています。文法的な概念は、コードそのものではないため、引用符で十分と判断されたと考えられます。さらに、一部の箇所では、引用符で囲まれたテキストに加えて、その文法要素の定義への直接リンクが追加されており、利便性が向上しています。 - 例:
- <code>xxx</code> statement
が+ "xxx" statement
に変更。- <code>if</code>, <code>for</code>, or <code>switch</code> statements
が+ <a href=\"#If_statements\">\"if\"</a>, <a href=\"#For_statements\">\"for\"</a>, or <a href=\"#Switch_statements\">\"switch\"</a> statements
に変更。ここでは、さらに各ステートメントへのリンクも追加されています。
- 変更前: 文法的な要素やキーワードを
-
不要なリンクの修正/削除:
- コミットメッセージに明示されている通り、文脈上不要になったり、冗長になったりしたリンクが削除または修正されています。これは、ドキュメントの簡潔性を保ち、読者の混乱を避けるためのメンテナンス作業です。例えば、既に文脈で十分に理解できる箇所や、より適切な表現がある箇所でリンクが削除されています。
これらの変更は、HTMLの構造とセマンティクスをより適切に利用し、Go言語仕様書という重要な技術文書の品質を向上させるための細かな調整です。これにより、仕様書はより現代的なWebドキュメントの慣習に沿った形となり、読者にとっての利便性が高まります。
コアとなるコードの変更箇所
変更はすべて doc/go_spec.html
ファイル内で行われています。以下に、変更の性質を示す代表的な差分をいくつか示します。
--- a/doc/go_spec.html
+++ b/doc/go_spec.html
@@ -639,8 +639,8 @@ expressions</a>.
<p>
A type determines the set of values and operations specific to values of that
type. A type may be specified by a
-(possibly <a href="§#Qualified_identifiers">qualified</a>) <i>type name</i>
-(§<a href="§#Type_declarations">Type declarations</a>) or a <i>type literal</i>,
+(possibly <a href="#Qualified_identifiers">qualified</a>)
+<a href="#Type_declarations"><i>type name</i></a> or a <i>type literal</i>,
which composes a new type from previously declared types.
</p>
@@ -866,8 +866,8 @@ distinct arrays always represent distinct storage.
The array underlying a slice may extend past the end of the slice.
The <i>capacity</i> is a measure of that extent: it is the sum of
the length of the slice and the length of the array beyond the slice;
-a slice of length up to that capacity can be created by `slicing\' a new
-one from the original slice (§<a href="§#Slices">Slices</a>).
+a slice of length up to that capacity can be created by
+<a href="#Slices"><i>slicing</i></a> a new one from the original slice.
The capacity of a slice <code>a</code> can be discovered using the
built-in function <a href="#Length_and_capacity"><code>cap(a)</code></a>.
</p>
@@ -1571,8 +1571,9 @@ declarations.
<p>
Labels are declared by <a href="#Labeled_statements">labeled statements</a> and are
-used in the <code>break</code>, <code>continue</code>, and <code>goto</code>
-statements (§<a href="§#Break_statements">Break statements</a>, §<a href="§#Continue_statements">Continue statements</a>, §<a href="§#Goto_statements">Goto statements</a>).
+used in the <a href="#Break_statements">"break"</a>,
+<a href="#Continue_statements">"continue"</a>, and
+<a href="#Goto_statements">"goto"</a> statements.
It is illegal to define a label that is never used.
In contrast to other identifiers, labels are not block scoped and do
not conflict with identifiers that are not labels. The scope of a label
@@ -1939,9 +1940,11 @@ a, a := 1, 2 // illegal: double declaration of a or
<p>
Short variable declarations may appear only inside functions.
-In some contexts such as the initializers for <code>if</code>,
-<code>for</code>, or <code>switch</code> statements,
-they can be used to declare local temporary variables (§<a href="§#Statements">Statements</a>).
+In some contexts such as the initializers for
+<a href="#If_statements">"if"</a>,
+<a href="#For_statements">"for"</a>, or
+<a href="#Switch_statements">"switch"</a> statements,
+they can be used to declare local temporary variables.
</p>
<h3 id="Function_declarations">Function declarations</h3>
コアとなるコードの解説
上記の差分は、コミットの意図を明確に示しています。
-
§
記号の削除とインテキストリンクへの変換:- 最初の差分では、
Type declarations
へのリンクが、以前は(possibly <a href="§#Qualified_identifiers">qualified</a>) <i>type name</i> (§<a href="§#Type_declarations">Type declarations</a>)
のように§
記号とセクション名が併記されていましたが、変更後は(possibly <a href="#Qualified_identifiers">qualified</a>) <a href="#Type_declarations"><i>type name</i></a>
のように、リンクテキスト自体が文脈に溶け込む形になっています。これにより、読者はより自然な形で関連情報にアクセスできます。 - 同様に、
Slices
へのリンクも(§<a href="§#Slices">Slices</a>)
から<a href="#Slices"><i>slicing</i></a>
へと変更され、動詞の一部としてリンクが埋め込まれています。これは、文脈に合わせたより自然な表現であり、読者の理解を助けます。
- 最初の差分では、
-
<code>
タグから引用符への変更とリンクの追加:break
,continue
,goto
ステートメントに関する記述では、以前はused in the <code>break</code>, <code>continue</code>, and <code>goto</code> statements (§<a href="§#Break_statements">Break statements</a>, §<a href="§#Continue_statements">Continue statements</a>, §<a href="§#Goto_statements">Goto statements</a>).
のように<code>
タグで囲まれていましたが、変更後はused in the <a href="#Break_statements">"break"</a>, <a href="#Continue_statements">"continue"</a>, and <a href="#Goto_statements">"goto"</a> statements.
のように、引用符で囲まれたテキストに各ステートメントへの直接リンクが追加されています。これは、文法的なキーワードをコードとしてではなく、引用されたテキストとして扱い、かつ読者がすぐにその定義に飛べるようにするための改善です。if
,for
,switch
ステートメントの初期化子に関する記述でも同様に、<code>
タグが削除され、各ステートメントへのリンクが追加されています。
これらの変更は、Go言語仕様書が単なる技術文書としてだけでなく、Webベースのインタラクティブなリソースとしての利便性を高めるためのものです。リンクの形式を統一し、用語の表現を洗練することで、読者はよりスムーズに情報を探索し、理解を深めることができるようになります。
関連リンク
- Go言語公式ウェブサイト: https://go.dev/
- Go言語仕様: https://go.dev/ref/spec (このコミットで変更された文書の最新版)
参考にした情報源リンク
- Gitの差分表示について: https://git-scm.com/docs/git-diff
- HTML
<a>
タグ: https://developer.mozilla.org/ja/docs/Web/HTML/Element/a - HTML
<code>
タグ: https://developer.mozilla.org/ja/docs/Web/HTML/Element/code - Go言語のコミット履歴 (GitHub): https://github.com/golang/go/commits/master
- Go言語のコードレビューシステム (Gerrit): https://go.dev/cl/ (コミットログにある
https://golang.org/cl/7821050
はGerritの変更リストへのリンクです) - Go Language Specification (in-text links context): https://go.dev/ref/spec