aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2023-07-19 09:13:57 +1000
committerEli Schwartz <eschwartz93@gmail.com>2023-07-18 19:49:08 -0400
commitf9debd3ae24a772056f19aa5f0746661f2259f6b (patch)
treeae49789559baec87bd9aba61703a73db30ff40fc
parent9d88d0d5cc92de04cb33cac4ddaedff622b65c40 (diff)
downloadmeson-f9debd3ae24a772056f19aa5f0746661f2259f6b.zip
meson-f9debd3ae24a772056f19aa5f0746661f2259f6b.tar.gz
meson-f9debd3ae24a772056f19aa5f0746661f2259f6b.tar.bz2
docs: fix typos and keyword markdown for the Rust module page
Two typos and mark the keyword arguments with backticks so they render nicely.
-rw-r--r--docs/markdown/Rust-module.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/markdown/Rust-module.md b/docs/markdown/Rust-module.md
index d3891bf..d606629 100644
--- a/docs/markdown/Rust-module.md
+++ b/docs/markdown/Rust-module.md
@@ -26,22 +26,22 @@ copying the sources and arguments passed to the original target and
adding the `--test` argument to the compilation, then creates a new
test target which calls that executable, using the rust test protocol.
-This accepts all of the keyword arguments as the
+This accepts all of the keyword arguments accepted by the
[[test]] function except `protocol`, it will set
that automatically.
-Additional, test only dependencies may be passed via the dependencies
+Additional, test-only dependencies may be passed via the `dependencies`
argument.
-*(since 1.2.0)* the link_with argument can be used to pass additional build
+*(since 1.2.0)* the `link_with` argument can be used to pass additional build
targets to link with
-*(since 1.2.0)* the `rust_args` keyword argument can be ussed to pass extra
+*(since 1.2.0)* the `rust_args` keyword argument can be used to pass extra
arguments to the Rust compiler.
### bindgen(*, input: string | BuildTarget | [](string | BuildTarget), output: string, include_directories: [](include_directories | string), c_args: []string, args: []string, dependencies: []Dependency)
This function wraps bindgen to simplify creating rust bindings around C
-libraries. This has two advantages over hand-rolling ones own with a
+libraries. This has two advantages over invoking bindgen with a
`generator` or `custom_target`:
- It handles `include_directories`, so one doesn't have to manually convert them to `-I...`
@@ -51,14 +51,14 @@ libraries. This has two advantages over hand-rolling ones own with a
It takes the following keyword arguments
-- input β€” A list of Files, Strings, or CustomTargets. The first element is
+- `input` β€” A list of Files, Strings, or CustomTargets. The first element is
the header bindgen will parse, additional elements are dependencies.
-- output β€” the name of the output rust file
-- include_directories β€” A list of `include_directories` or `string` objects,
+- `output` β€” the name of the output rust file
+- `include_directories` β€” A list of `include_directories` or `string` objects,
these are passed to clang as `-I` arguments *(string since 1.0.0)*
-- c_args β€” A list of string arguments to pass to clang untouched
-- args β€” A list of string arguments to pass to `bindgen` untouched.
-- dependencies β€” A list of `Dependency` objects to pass to the underlying clang call (*since 1.0.0*)
+- `c_args` β€” A list of string arguments to pass to clang untouched
+- `args` β€” A list of string arguments to pass to `bindgen` untouched.
+- `dependencies` β€” A list of `Dependency` objects to pass to the underlying clang call (*since 1.0.0*)
```meson
rust = import('unstable-rust')