Fix broken relative links.

This commit is contained in:
Qi Xiao 2021-11-29 20:03:09 +00:00
parent 27421a0c25
commit a0b93968a3
12 changed files with 31 additions and 32 deletions

View File

@ -283,14 +283,14 @@ func multiErrorFn(excs ...Exception) error {
//elvdoc:fn return
//
// Raises the special "return" exception. When raised inside a named function
// (defined by the [`fn` keyword](../language.html#function-definition-fn)) it
// is captured by the function and causes the function to terminate. It is not
// captured by an anonymous function (aka [lambda](../language.html#lambda)).
// (defined by the [`fn` keyword](language.html#fn)) it is captured by the
// function and causes the function to terminate. It is not captured by an
// ordinary anonymous function.
//
// Because `return` raises an exception it can be caught by a
// [`try`](language.html#exception-control-try) block. If not caught, either
// implicitly by a named function or explicitly, it causes a failure like any
// other uncaught exception.
// [`try`](language.html#try) block. If not caught, either implicitly by a
// named function or explicitly, it causes a failure like any other uncaught
// exception.
//
// See the discussion about [flow commands and
// exceptions](language.html#exception-and-flow-commands)
@ -330,9 +330,8 @@ func returnFn() error {
// captured and causes the loop to terminate.
//
// Because `break` raises an exception it can be caught by a
// [`try`](language.html#exception-control-try) block. If not caught, either
// implicitly by a loop or explicitly, it causes a failure like any other
// uncaught exception.
// [`try`](language.html#try) block. If not caught, either implicitly by a loop
// or explicitly, it causes a failure like any other uncaught exception.
//
// See the discussion about [flow commands and exceptions](language.html#exception-and-flow-commands)
//
@ -357,9 +356,8 @@ func breakFn() error {
// captured and causes the loop to begin its next iteration.
//
// Because `continue` raises an exception it can be caught by a
// [`try`](language.html#exception-control-try) block. If not caught, either
// implicitly by a loop or explicitly, it causes a failure like any other
// uncaught exception.
// [`try`](language.html#try) block. If not caught, either implicitly by a loop
// or explicitly, it causes a failure like any other uncaught exception.
//
// See the discussion about [flow commands and exceptions](language.html#exception-and-flow-commands)
//

View File

@ -376,7 +376,7 @@ var TimeAfter = func(fm *Frame, d time.Duration) <-chan time.Time {
// contexts that might be executing in parallel as a consequence of a command
// such as [`peach`](#peach).
//
// A duration can be a simple [number](../language.html#number) (with optional
// A duration can be a simple [number](language.html#number) (with optional
// fractional value) without an explicit unit suffix, with an implicit unit of
// seconds.
//

View File

@ -69,7 +69,7 @@ func init() {
// command outputs it as is.
//
// This command is usually not needed for working with numbers; see the
// discussion of [numerical commands](#numerical-commands).
// discussion of [numeric commands](#numeric-commands).
//
// Examples:
//

View File

@ -66,7 +66,7 @@ func close(f vals.File) error {
// ```
//
// Create a new pipe that can be used in redirections. A pipe contains a read-end and write-end.
// Each pipe object is a [pseudo-map](#pseudo-map) with fields `r` (the read-end [file
// Each pipe object is a [pseudo-map](language.html#pseudo-map) with fields `r` (the read-end [file
// object](./language.html#file)) and `w` (the write-end).
//
// When redirecting command input from a pipe with `<`, the read-end is used. When redirecting

View File

@ -267,8 +267,8 @@ func tempDir(opts mktempOpt, args ...string) (string, error) {
// defaults to `elvish-*`.
//
// It is the caller's responsibility to close the file with
// [`file:close`](file.html#close). The caller should also remove the file if it
// is intended to be temporary (with `rm $f[name]`).
// [`file:close`](file.html#fileclose). The caller should also remove the file
// if it is intended to be temporary (with `rm $f[name]`).
//
// ```elvish-transcript
// ~> f = path:temp-file

View File

@ -352,7 +352,7 @@ func join(sep string, inputs eval.Inputs) (string, error) {
// non-negative, it determines the max number of substitutions.
//
// **Note**: This command does not support searching by regular expressions, `$old`
// is always interpreted as a plain string. Use [re:replace](re.html#replace) if
// is always interpreted as a plain string. Use [re:replace](re.html#rereplace) if
// you need to search by regex.
type maxOpt struct{ Max int }
@ -388,7 +388,7 @@ func replace(opts maxOpt, old, repl, s string) string {
// ```
//
// **Note**: This command does not support splitting by regular expressions,
// `$sep` is always interpreted as a plain string. Use [re:split](re.html#split)
// `$sep` is always interpreted as a plain string. Use [re:split](re.html#resplit)
// if you need to split by regex.
//
// Etymology: Various languages, in particular
@ -440,7 +440,7 @@ func split(fm *eval.Frame, opts maxOpt, sep, s string) error {
//
// The output format is subject to change.
//
// @cf from-codepoints
// @cf str:from-codepoints
func toCodepoints(fm *eval.Frame, s string) error {
out := fm.ValueOutput()
@ -489,7 +489,7 @@ func toCodepoints(fm *eval.Frame, s string) error {
//
// The output format is subject to change.
//
// @cf from-utf8-bytes
// @cf str:from-utf8-bytes
func toUtf8Bytes(fm *eval.Frame, s string) error {
out := fm.ValueOutput()

View File

@ -39,7 +39,7 @@ const (
// restored. **Warning**: Since the umask applies to the entire process, not
// individual threads, changing it temporarily in this manner is dangerous if
// you are doing anything in parallel. Such as via the
// [`peach`](ref/builtin.html#peach) command.
// [`peach`](builtin.html#peach) command.
// UmaskVariable is a variable whose value always reflects the current file
// creation permission mask. Setting it changes the current file creation

View File

@ -268,7 +268,8 @@ apt install elvish
However, only testing versions of Debian and Ubuntu tend to have the latest
Elvish release. If you are running a stable release of Debian or Ubuntu, it is
recommended to use official [prebuilt binaries](#prebuilt-binaries) instead.
recommended to [install an official binaries](#installing-an-official-binary)
instead.
## macOS

View File

@ -4,8 +4,7 @@
The semantics of Elvish is unique in many aspects when compared to other shells.
This can be surprising if you are used to other shells, and it is a result of
the [design choice](../ref/philosophy.html) of making Elvish a full-fledged
programming language.
the design choice of making Elvish a full-fledged programming language.
# Structureful IO
@ -202,7 +201,7 @@ echo "after false"
An alternative way to describe this is that Elvish **does** have exit statuses,
but non-zero exit statuses terminates execution by default. You can handle
non-zero exit statuses by wrapping the command in a
[`try`](../language.html#exception-control-try) block.
[`try`](../ref/language.html#try) block.
Compare with POSIX shells, the behavior of Elvish is similar to `set -e` or
`set -o errexit`, or having implicit `&&` operators joining all the commands.

View File

@ -50,7 +50,7 @@ manages one of them:
- On Windows, `epm` manages `%LocalAppData%\elvish\lib`.
This directory is called the `epm`-managed directory, and its path is available
as [`$epm:managed-dir`](#epm-managed-dir).
as [`$epm:managed-dir`](#epmmanaged-dir).
# Custom package domains

View File

@ -436,7 +436,7 @@ turn a pseudo-map. The reason pseudo-map has has a `type` field identifying how
the exception was raised, and further fields depending on the type:
- If the `type` field is `fail`, the exception was raised by the
[fail](builtins.html#fail) command.
[fail](builtin.html#fail) command.
In this case, the `content` field contains the argument to `fail`.
@ -498,8 +498,9 @@ Examples:
## File
There is no literal syntax for the file type. This type is returned by commands
such as [file:open](file.html#open) and [path:temp-file](path.html#temp-file).
It can be used as the target of a redirection rather than a filename.
such as [file:open](file.html#fileopen) and
[path:temp-file](path.html#pathtemp-file). It can be used as the target of a
redirection rather than a filename.
A file object is a [pseudo-map](#pseudo-map) with fields `fd` (an int) and
`name` (a string). If the file is closed the fd will be -1.
@ -2419,7 +2420,7 @@ order:
the `use` command.
1. **User defined**: These match a [user defined module](#user-defined-modules)
in a [module search directory](#module-search-directories).
in a [module search directory](command.html#module-search-directories).
1. **Pre-defined**: These match the name of a
[pre-defined module](#pre-defined-modules), such as `math` or `str`.

View File

@ -14,7 +14,7 @@ use readline-binding
Note that this will override some of the standard bindings. For example, <span
class="key">Ctrl-L</span> will be bound to a function that clears the terminal
screen rather than start [location mode](../learn/cookbook.html).
screen rather than start location mode.
See the
[source code](https://github.com/elves/elvish/blob/master/pkg/mods/bundled/readline-binding.elv.go)