diff options
| author | Guillaume Grossetie <ggrossetie@gmail.com> | 2022-08-22 20:47:27 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-22 12:47:27 -0600 |
| commit | d72fe54346aa6963ae835f48681fa1ed917fb3fe (patch) | |
| tree | 4896c6906efb3ee81aebde948580dd46767eb7c4 /docs/modules/api | |
| parent | 81e3e772f1294f85a5be7d34d06e132494c44e5b (diff) | |
proofread documentation (PR #4336)
Diffstat (limited to 'docs/modules/api')
| -rw-r--r-- | docs/modules/api/pages/catalog-assets.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/api/pages/convert-files.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/api/pages/convert-strings.adoc | 6 | ||||
| -rw-r--r-- | docs/modules/api/pages/sourcemap.adoc | 2 |
4 files changed, 6 insertions, 6 deletions
diff --git a/docs/modules/api/pages/catalog-assets.adoc b/docs/modules/api/pages/catalog-assets.adoc index 6ba2d043..663c78fa 100644 --- a/docs/modules/api/pages/catalog-assets.adoc +++ b/docs/modules/api/pages/catalog-assets.adoc @@ -176,7 +176,7 @@ In the output, the image references will be shown as absolute paths. === :refs In addition to images and links, you can also access all targetable references (i.e., elements that have an ID). -First, let's add some referencable elements to our document. +First, let's add some referenceable elements to our document. [,asciidoc] ---- diff --git a/docs/modules/api/pages/convert-files.adoc b/docs/modules/api/pages/convert-files.adoc index 8eb3cb91..94dcfdb0 100644 --- a/docs/modules/api/pages/convert-files.adoc +++ b/docs/modules/api/pages/convert-files.adoc @@ -1,7 +1,7 @@ = Load and Convert Files Using the API :navtitle: Load and Convert Files -This page explains how to load and convert AsciiDoc-formatted files using the API. +This page explains how to load and convert AsciiDoc files using the API. == Load an AsciiDoc file diff --git a/docs/modules/api/pages/convert-strings.adoc b/docs/modules/api/pages/convert-strings.adoc index 25efb655..c4ef8d3c 100644 --- a/docs/modules/api/pages/convert-strings.adoc +++ b/docs/modules/api/pages/convert-strings.adoc @@ -1,12 +1,12 @@ = Load and Convert Strings Using the API :navtitle: Load and Convert Strings -This page explains how to load and convert AsciiDoc-formatted strings using the API. +This page explains how to load and convert AsciiDoc strings using the API. A string is the bare AsciiDoc content (often the contents of a file). == Load an AsciiDoc string -To parse an AsciiDoc-formatted string into a document object model, use: +To parse an AsciiDoc string into a document object model, use: [source,ruby] ---- @@ -32,7 +32,7 @@ However, if you're only interested in converting the AsciiDoc source when using == Convert an AsciiDoc string -To convert the AsciiDoc-formatted string directly to HTML, use: +To convert the AsciiDoc string directly to HTML, use: [source,ruby] ---- diff --git a/docs/modules/api/pages/sourcemap.adoc b/docs/modules/api/pages/sourcemap.adoc index c65d494c..ed32891f 100644 --- a/docs/modules/api/pages/sourcemap.adoc +++ b/docs/modules/api/pages/sourcemap.adoc @@ -151,4 +151,4 @@ The lineno of the paragraph in the source location is now one greater than befor .... If you're writing a custom converter, the source location is not available for inline elements. -However, you can access the source location of the parent element (e.g., `node.parent.source_location`), which should at leasat get you close to the location of the element. +However, you can access the source location of the parent element (e.g., `node.parent.source_location`), which should at least get you close to the location of the element. |