From b80c70ffc66e665721de16413a539b00990fc344 Mon Sep 17 00:00:00 2001 From: GreenXenith <24834740+GreenXenith@users.noreply.github.com> Date: Tue, 4 Jan 2022 17:22:11 -0800 Subject: [PATCH] Weird grave-quote interaction --- HOWTO.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HOWTO.adoc b/HOWTO.adoc index ae1628c..0735bd6 100644 --- a/HOWTO.adoc +++ b/HOWTO.adoc @@ -65,7 +65,7 @@ All we need to know is that it helps us handle `ThatObject`. What it actually do === Internal Implementations In general, describing internal implementations is unnecessary and confusing. Avoid it unless absolutely essential for understanding something. -This applies to meta implementations as well. For example, given the constructor `YourObject()`, do not document it as `YourObject.new(self, o)`. When describing the constructor, say "Creates and returns a new `YourObject`". Do not go into unnecessary detail about what it does under the hood, such as `__index` management. +This applies to meta implementations as well. For example, given the constructor `YourObject()`, do not document it as `YourObject.new(self, o)`. When describing the constructor, say "Creates and returns a new `YourObject` ". Do not go into unnecessary detail about what it does under the hood, such as `__index` management. == Format See link:templates/standard.adoc[standard template] for an example.