Skip to content

Commit d92433a

Browse files
committed
Docs: Fix backticks in how to docs (#11018)
In the "methods" sections of the how to develop a plugin docs Asciidoctor as incorrectly passing backticks into the output when it should have marked the words surrounded by backticks as code. I'm not 100% sure why it did that. The fix is to force macro evaluation immediately on attribute assignment.
1 parent 51e7d19 commit d92433a

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/static/codec.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@
1010

1111
:getstarted: Let's step through creating a {plugintype} plugin using the https://github.com/logstash-plugins/logstash-codec-example/[example {plugintype} plugin].
1212

13-
:methodheader: Logstash codecs must implement the `register` method, and the `decode` method or the `encode` method (or both).
13+
:methodheader: pass:m[Logstash codecs must implement the `register` method, and the `decode` method or the `encode` method (or both).]
1414

1515
include::include/pluginbody.asciidoc[]

docs/static/filter.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99

1010
:getstarted: Let's step through creating a {plugintype} plugin using the https://github.com/logstash-plugins/logstash-filter-example/[example {plugintype} plugin].
1111

12-
:methodheader: Logstash filters must implement the `register` and `filter` methods.
12+
:methodheader: pass:m[Logstash filters must implement the `register` and `filter` methods.]
1313

1414
include::include/pluginbody.asciidoc[]

docs/static/input.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77

88
:getstarted: Let's step through creating an {plugintype} plugin using the https://github.com/logstash-plugins/logstash-input-example/[example {plugintype} plugin].
99

10-
:methodheader: Logstash inputs must implement two main methods: `register` and `run`.
10+
:methodheader: pass:m[Logstash inputs must implement two main methods: `register` and `run`.]
1111

1212
include::include/pluginbody.asciidoc[]

docs/static/output.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99

1010
:getstarted: Let's step through creating an {plugintype} plugin using the https://github.com/logstash-plugins/logstash-output-example/[example {plugintype} plugin].
1111

12-
:methodheader: Logstash outputs must implement the `register` and `multi_receive` methods.
12+
:methodheader: pass:m[Logstash outputs must implement the `register` and `multi_receive` methods.]
1313

1414
include::include/pluginbody.asciidoc[]

0 commit comments

Comments
 (0)