Skip to content

Commit 0d3e431

Browse files
docs: fix broken link, add clarity to plugins doc (#2813)
1 parent 7dc0e7c commit 0d3e431

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

docs/guides/plugins.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Authoring plugins
1+
# Using plugins
22

3-
To use plugins, you must be using [Version 2](../reference/config.md) of
3+
To use plugins, you must be using [Version 2](../reference/config.md#version-2) of
44
the configuration file. The top-level `plugins` array defines the available
55
plugins.
66

77
## WASM plugins
88

9-
> WASM plugins are fully sandboxed. Plugins do not have access to the network,
9+
> WASM plugins are fully sandboxed; they do not have access to the network,
1010
> filesystem, or environment variables.
1111
1212
In the `codegen` section, the `out` field dictates what directory will contain
1313
the new files. The `plugin` key must reference a plugin defined in the
14-
top-level `plugins` map. The `options` are serialized to a string and passed on
15-
to the plugin itself.
14+
top-level `plugins` map. Any `options` are serialized to a string as JSON and
15+
passed on to the plugin itself.
1616

1717

1818
```yaml
@@ -29,6 +29,8 @@ sql:
2929
codegen:
3030
- out: gen
3131
plugin: greeter
32+
options:
33+
lang: en-US
3234
```
3335
3436
For a complete working example see the following files:
@@ -44,8 +46,8 @@ For a complete working example see the following files:
4446
4547
In the `codegen` section, the `out` field dictates what directory will contain
4648
the new files. The `plugin` key must reference a plugin defined in the
47-
top-level `plugins` map. The `options` are serialized to a string and passed on
48-
to the plugin itself.
49+
top-level `plugins` map. Any `options` are serialized to a string as JSON and
50+
passed on to the plugin itself.
4951

5052
```yaml
5153
version: '2'

docs/reference/datatypes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
database types to Go types. Choices for more complex types are described below.
55

66
If you're unsatisfied with the default, you can override any type using the
7-
[overrides list](config.html#type-overriding) in your `sqlc` config file.
7+
[overrides list](./config.html#type-overriding) in your `sqlc` config file.
88

99
## Arrays
1010

0 commit comments

Comments
 (0)