diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-10-28 23:52:00 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-10-29 02:35:04 -0600 |
| commit | a227fcd0129e03e2478390a27dd02965a3146ab4 (patch) | |
| tree | 763ec033fa9285ce20ffea2e044ec800505b3b89 /docs | |
| parent | fcfa4964dc05c5743476bb9a225154e2d6a00a50 (diff) | |
update the apidoc for the Document#write method [skip ci]
- document the parameters of Document#write
- document that Document#write ensures the output has a trailing newline when the target responds to write
- add a note docs that explains when the processor ensures the output has a trailing newline
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/modules/convert/pages/custom.adoc | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/modules/convert/pages/custom.adoc b/docs/modules/convert/pages/custom.adoc index bfbf37ce..df9537f6 100644 --- a/docs/modules/convert/pages/custom.adoc +++ b/docs/modules/convert/pages/custom.adoc @@ -37,7 +37,7 @@ One such technique is to use temporary XML tags around boundaries of inline elem The https://github.com/asciidoctor/asciidoctor/blob/HEAD/lib/asciidoctor/converter/manpage.rb[built-in man page converter] provides a good example of these techniques. **** -A converter is typically instantiated each time an AsciiDoc document is processed. +Unless a converter instance is passed to the processor, the converter is instantiated each time an AsciiDoc document is processed. A converter in Asciidoctor is not designed to be reused from one conversion to the next and is therefore stateless. Implementing a custom converter consists of the following steps: @@ -357,6 +357,9 @@ Here's an example of the output you will get: </topic> ---- +NOTE: If the value of the `:to_file` option passed to Asciidoctor's convert API responds to the `write` method (e.g., an IO object), Asciidoctor will ensure the output has a trailing newline character. +Otherwise, it's up to the converter to decide whether to append a trailing newline character to the output. + If you don't register the converter with a backend, you can pass the converter class (or instance) using the `:converter` option of the xref:api:index.adoc[Asciidoctor API], as shown in the following code snippet: [,rb] |
