HSEARCH-4843 Fix a few unrelated mistakes in the documentation

hibernate · May 1, 2023 · 713cc13 · 713cc13
1 parent 789bffb
commit 713cc13
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git a/documentation/src/main/asciidoc/reference/backend-elasticsearch.asciidoc b/documentation/src/main/asciidoc/reference/backend-elasticsearch.asciidoc
@@ -1010,9 +1010,9 @@ A different analysis configurer can be assigned to each index:
 [source]
 ----
 # To set the default configurer for all indexes:
-hibernate.search.backend.analysis.configurer = com.mycompany.MyAnalysisConfigurer
+hibernate.search.backend.analysis.configurer = class:com.mycompany.MyAnalysisConfigurer
 # To assign a specific configurer to a specific index:
-hibernate.search.backend.indexes.<index-name>.analysis.configurer = com.mycompany.MySpecificAnalysisConfigurer
+hibernate.search.backend.indexes.<index-name>.analysis.configurer = class:com.mycompany.MySpecificAnalysisConfigurer
 ----
 
 If a specific configurer is assigned to an index,
@@ -1030,7 +1030,7 @@ The Elasticsearch backend comes with several built-in analyzers.
 The exact list depends on the version of Elasticsearch and can be found
 link:{elasticsearchDocUrl}/analysis-analyzers.html[here].
 
-Regardless of the Elasticsearch version;
+Regardless of the Elasticsearch version,
 analyzers whose name is listed as a constant in `org.hibernate.search.engine.backend.analysis.AnalyzerNames`
 are always available:
 

diff --git a/documentation/src/main/asciidoc/reference/configuration.asciidoc b/documentation/src/main/asciidoc/reference/configuration.asciidoc
@@ -433,7 +433,7 @@ the context also lists references to entities that could not be indexed correctl
 ----
 include::{resourcesdir}/reporting/failurehandler.properties[]
 ----
-<1> Assign the background failure handler using a Hibernate Search configuration property.
+Assign the background failure handler using a Hibernate Search configuration property.
 ====
 
 [NOTE]

diff --git a/documentation/src/test/resources/reporting/failurehandler.properties b/documentation/src/test/resources/reporting/failurehandler.properties
@@ -1,2 +1 @@
-# <1>
-hibernate.search.background_failure_handler = org.hibernate.search.documentation.reporting.failurehandler.MyFailureHandler
+hibernate.search.background_failure_handler = class:org.hibernate.search.documentation.reporting.failurehandler.MyFailureHandler