This is an automated email from the ASF dual-hosted git repository. nightowl888 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit cc551b0a1c94345896a6d2fdbbf2cdc4580f8fa2 Author: Shad Storhaug <[email protected]> AuthorDate: Tue Mar 30 19:45:10 2021 +0700 docs: Lucene.Net.TestFramework: Fixed broken formatting and links (see #284, #300) --- src/Lucene.Net.TestFramework/Analysis/package.md | 8 ++++++-- src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md | 4 ++-- src/Lucene.Net.TestFramework/Index/package.md | 7 +++++-- src/Lucene.Net.TestFramework/Search/package.md | 7 +++++-- src/Lucene.Net.TestFramework/Util/package.md | 4 ++-- 5 files changed, 20 insertions(+), 10 deletions(-) diff --git a/src/Lucene.Net.TestFramework/Analysis/package.md b/src/Lucene.Net.TestFramework/Analysis/package.md index e1bc0b4..ae6abce 100644 --- a/src/Lucene.Net.TestFramework/Analysis/package.md +++ b/src/Lucene.Net.TestFramework/Analysis/package.md @@ -1,4 +1,4 @@ ---- +--- uid: Lucene.Net.Analysis summary: *content --- @@ -22,4 +22,8 @@ summary: *content Support for testing analysis components. - The main classes of interest are: * <xref:Lucene.Net.Analysis.BaseTokenStreamTestCase>: Highly recommended to use its helper methods, (especially in conjunction with <xref:Lucene.Net.Analysis.MockAnalyzer> or <xref:Lucene.Net.Analysis.MockTokenizer>), as it contains many assertions and checks to catch bugs. * <xref:Lucene.Net.Analysis.MockTokenizer>: Tokenizer for testing. Tokenizer that serves as a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a compone [...] \ No newline at end of file +The main classes of interest are: + +* <xref:Lucene.Net.Analysis.BaseTokenStreamTestCase>: Highly recommended to use its helper methods, (especially in conjunction with <xref:Lucene.Net.Analysis.MockAnalyzer> or <xref:Lucene.Net.Analysis.MockTokenizer>), as it contains many assertions and checks to catch bugs. +* <xref:Lucene.Net.Analysis.MockTokenizer>: Tokenizer for testing. Tokenizer that serves as a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a TokenFilter, its a great idea to test it wrapping this tokenizer instead for extra checks. +* <xref:Lucene.Net.Analysis.MockAnalyzer>: Analyzer for testing. Analyzer that uses MockTokenizer for additional verification. If you are testing a custom component such as a query parser or analyzer-wrapper that consumes analysis streams, its a great idea to test it with this analyzer instead. \ No newline at end of file diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md b/src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md index f6b2e22..34fdcc5 100644 --- a/src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md +++ b/src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md @@ -1,4 +1,4 @@ ---- +--- uid: Lucene.Net.Codecs.Lucene41Ords summary: *content --- @@ -20,4 +20,4 @@ summary: *content limitations under the License. --> -Codec for testing that supports [#ord()](xref:Lucene.Net.Index.TermsEnum) \ No newline at end of file +Codec for testing that supports [TermsEnum.Ord](xref:Lucene.Net.Index.TermsEnum#Lucene_Net_Index_TermsEnum_Ord) \ No newline at end of file diff --git a/src/Lucene.Net.TestFramework/Index/package.md b/src/Lucene.Net.TestFramework/Index/package.md index 7af00a8..23fc3ee 100644 --- a/src/Lucene.Net.TestFramework/Index/package.md +++ b/src/Lucene.Net.TestFramework/Index/package.md @@ -1,4 +1,4 @@ ---- +--- uid: Lucene.Net.Index summary: *content --- @@ -22,4 +22,7 @@ summary: *content Support for testing of indexes. - The primary classes are: * <xref:Lucene.Net.Index.RandomIndexWriter>: Randomizes the indexing experience. * <xref:Lucene.Net.Index.MockRandomMergePolicy>: MergePolicy that makes random decisions. \ No newline at end of file +The primary classes are: + +* <xref:Lucene.Net.Index.RandomIndexWriter>: Randomizes the indexing experience. +* <xref:Lucene.Net.Index.MockRandomMergePolicy>: MergePolicy that makes random decisions. \ No newline at end of file diff --git a/src/Lucene.Net.TestFramework/Search/package.md b/src/Lucene.Net.TestFramework/Search/package.md index f1e16bd..5052f93 100644 --- a/src/Lucene.Net.TestFramework/Search/package.md +++ b/src/Lucene.Net.TestFramework/Search/package.md @@ -1,4 +1,4 @@ ---- +--- uid: Lucene.Net.Search summary: *content --- @@ -22,4 +22,7 @@ summary: *content Support for testing search components. - The primary classes are: * <xref:Lucene.Net.Search.QueryUtils>: Useful methods for testing Query classes. * <xref:Lucene.Net.Search.ShardSearchingTestBase>: Base class for simulating distributed search. \ No newline at end of file +The primary classes are: + +* <xref:Lucene.Net.Search.QueryUtils>: Useful methods for testing Query classes. +* <xref:Lucene.Net.Search.ShardSearchingTestBase>: Base class for simulating distributed search. \ No newline at end of file diff --git a/src/Lucene.Net.TestFramework/Util/package.md b/src/Lucene.Net.TestFramework/Util/package.md index 10c4151..97ba256 100644 --- a/src/Lucene.Net.TestFramework/Util/package.md +++ b/src/Lucene.Net.TestFramework/Util/package.md @@ -1,4 +1,4 @@ ---- +--- uid: Lucene.Net.Util summary: *content --- @@ -21,4 +21,4 @@ summary: *content --> General test support. The primary class is <xref:Lucene.Net.Util.LuceneTestCase>, -which extends JUnit with additional functionality. \ No newline at end of file +which extends NUnit with additional functionality. \ No newline at end of file
