_content/doc: fix typos, broken links, and text formatting
For golang/go#44241
Change-Id: Ie23c99c6e36c618d0a3135167cf780f02ea3e3ea
Reviewed-on: https://go-review.googlesource.com/c/website/+/293229
Run-TryBot: Steve Traut <straut@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Steve Traut <straut@google.com>
Trust: Dmitri Shuralyov <dmitshur@golang.org>
diff --git a/_content/doc/modules/gomod-ref.md b/_content/doc/modules/gomod-ref.md
index 7eb41b0..bdbe853 100644
--- a/_content/doc/modules/gomod-ref.md
+++ b/_content/doc/modules/gomod-ref.md
@@ -59,7 +59,7 @@
require (
example.com/othermodule v1.2.3
-example.com/thismodule v1.2.3
+ example.com/thismodule v1.2.3
example.com/thatmodule v1.2.3
)
@@ -205,11 +205,11 @@
<dd>The path at which Go should look for the required module. This can be a
module path or a path to a directory on the file system local to the
replacement module. If this is a module path, you must specify a
- _replacement-version_ value. If this is a local path, you may not use a
- _replacement-version_ value.</dd>
+ <em>replacement-version</em> value. If this is a local path, you may not use a
+ <em>replacement-version</em> value.</dd>
<dt>replacement-version</dt>
<dd>The version of the replacement module. The replacement version may only
- be specified if _replacement-path_ is a module path (not a local directory).</dd>
+ be specified if <em>replacement-path</em> is a module path (not a local directory).</dd>
</dl>
### Examples
@@ -222,7 +222,7 @@
```
require example.com/othermodule v1.2.3
- replace example.com/othermodule => example.com/myfork/othermodule
+ replace example.com/othermodule => example.com/myfork/othermodule v1.2.3-fixed
```
When you replace one module path with another, do not change import statements
diff --git a/_content/doc/modules/major-version.md b/_content/doc/modules/major-version.md
index 59b0118..fe1555b 100644
--- a/_content/doc/modules/major-version.md
+++ b/_content/doc/modules/major-version.md
@@ -82,7 +82,7 @@
* In your Go code, update every imported package path where you import a package
from the module, appending the major version number to the module path portion.
- * Old import statement: `import example.com/mymodule/package1`
- * New import statement: `import example.com/mymodule/v2/package1`
+ * Old import statement: `import "example.com/mymodule/package1"`
+ * New import statement: `import "example.com/mymodule/v2/package1"`
For publishing steps, see [Publishing a module](publishing).
diff --git a/_content/doc/modules/managing-dependencies.md b/_content/doc/modules/managing-dependencies.md
index 0b432c2..671ec5a 100644
--- a/_content/doc/modules/managing-dependencies.md
+++ b/_content/doc/modules/managing-dependencies.md
@@ -61,7 +61,7 @@
Developers make their modules available for other developers to use from
their own repository and publish with a version number.
* A **package search engine** and documentation browser (pkg.go.dev) at which
- you can find modules. See [Package discovery](#discovery).
+ you can find modules. See [Package discovery](developing#discovery).
* A module **version numbering convention** to help you understand a module's
stability and backward compatibility guarantees. See [Module version
numbering](version-numbers).
@@ -203,7 +203,7 @@
You can check to see if there are newer versions of dependencies you're already
using in your current module. Use the `go list` command to display a list of
your module's dependencies, along with the latest version available for that
-module. One you've discovered available upgrades, you can try them out with your
+module. Once you've discovered available upgrades, you can try them out with your
code to decide whether or not to upgrade to new versions.
For more about the `go list` command, see the [`go` command
diff --git a/_content/doc/modules/publishing.md b/_content/doc/modules/publishing.md
index cd64179..db5ec4f 100644
--- a/_content/doc/modules/publishing.md
+++ b/_content/doc/modules/publishing.md
@@ -62,8 +62,8 @@
```
1. Make the module available by running the [`go list`
- command](https://golang.org/cmd/go/#hdr-List_packages_or_modules) to prompt
- Go to update its index of modules with 1nformation about the module you're
+ command](/cmd/go/#hdr-List_packages_or_modules) to prompt
+ Go to update its index of modules with information about the module you're
publishing.
Precede the command with a statement to set the `GOPROXY` environment
@@ -74,10 +74,12 @@
$ GOPROXY=proxy.golang.org go list -m example.com/mymodule@v0.1.0
```
-Developers interested in your module import a package from it and run the [`go
-get` command]() just as they would with any other module. They can run the [`go
-get` command]() for latest versions or they can specify a particular version, as
-in the following example:
+Developers interested in your module import a package from it and run the
+[`go get` command](/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them)
+just as they would with any other module. They can run the
+[`go get` command](/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them)
+for latest versions or they can specify a particular version, as in the
+following example:
```
$ go get example.com/mymodule@v0.1.0
diff --git a/_content/doc/modules/version-numbers.md b/_content/doc/modules/version-numbers.md
index 8e74763..ca1acdd 100644
--- a/_content/doc/modules/version-numbers.md
+++ b/_content/doc/modules/version-numbers.md
@@ -18,7 +18,7 @@
**See also**
* When you're using external packages in your code, you can manage those
- dependencies with Go tools. For more, see [Managingdependencies](managing-dependencies).
+ dependencies with Go tools. For more, see [Managing dependencies](managing-dependencies).
* If you're developing modules for others to use, you apply a version number
when you publish the module, tagging the module in its repository. For more,
see [Publishing a module](publishing).
diff --git a/_content/doc/tutorial/call-module-code.html b/_content/doc/tutorial/call-module-code.html
index b7f7649..3c3602b 100644
--- a/_content/doc/tutorial/call-module-code.html
+++ b/_content/doc/tutorial/call-module-code.html
@@ -135,9 +135,9 @@
<p>
Here, the
- <a href="https://golang.org/ref/mod#tmp_15"
- ><code>replace</code> directive</a
- >
+ <a href="/ref/mod#go-mod-file-replace">
+ <code>replace</code> directive
+ </a>
tells Go to replace the module path (the URL
<code>example.com/greetings</code>) with a path you specify. In this
case, that's a greetings directory next to the hello directory.
@@ -172,9 +172,9 @@
<p>
To build the module, Go found the local code in the ../greetings
directory, then added a
- <a href="https://golang.org/ref/mod#tmp_13"
- ><code>require</code> directive</a
- >
+ <a href="/ref/mod#go-mod-file-require">
+ <code>require</code> directive
+ </a>
to specify that <code>hello</code> is dependent on (requires)
<code>example.com/greetings</code>. You created this dependency when
you imported the <code>greetings</code> package (contained in the
diff --git a/_content/doc/tutorial/create-module.html b/_content/doc/tutorial/create-module.html
index 44e0d83..cf6558c 100644
--- a/_content/doc/tutorial/create-module.html
+++ b/_content/doc/tutorial/create-module.html
@@ -18,7 +18,7 @@
</p>
<p>
- This tutorial's sequence includes six brief topics that each illustrate a
+ This tutorial's sequence includes seven brief topics that each illustrate a
different part of the language.
</p>
diff --git a/_content/doc/tutorial/getting-started.html b/_content/doc/tutorial/getting-started.html
index a92cf20..fc05867 100644
--- a/_content/doc/tutorial/getting-started.html
+++ b/_content/doc/tutorial/getting-started.html
@@ -207,7 +207,7 @@
(if you see <code>rsc.io/quote/v3</code>, ignore it for now).
</li>
<li>
- On the <strong>Doc</strong> tab, under <strong>Index</strong>, note the
+ In the <strong>Documentation</strong> section, under <strong>Index</strong>, note the
list of functions you can call from your code. You'll use the
<code>Go</code> function.
</li>
