database/doris
2
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Merge Help document to documentation (#1586)

Browse Source 
Help document collation (integration of help and documentation documents)
This commit is contained in:
xy720
2019-08-07 21:31:53 +08:00
committed by ZHAO Chun
parent 41cbedf57d
commit 4c2a3d6da4
181 changed files with 3577 additions and 3971 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
fe/src/test/java/org/apache/doris/common/MarkDownParserTest.java Normal file → Executable file
View File

@ -117,17 +117,48 @@ public class MarkDownParserTest {
Assert.fail("No exception throws.");
}
@Test(expected = UserException.class)
public void testErrorState() throws UserException {
// When encounter a headlevel at 3 or greater, we ignore it rather than throw exception
// @Test(expected = UserException.class)
// public void testErrorState() throws UserException {
// List<String> lines = Lists.newArrayList();
// lines.add("# SHOW TABLES");
// lines.add("## name");
// lines.add("### name");
// MarkDownParser parser = new MarkDownParser(lines);
// Map<String, Map<String, String>> map = parser.parse();
// Assert.fail("No exception throws.");
// }
@Test
public void testMultiHeadLevel() throws UserException {
List<String> lines = Lists.newArrayList();
lines.add("# SHOW TABLES");
lines.add("## name");
lines.add("### name");
lines.add(" SHOW TABLES");
lines.add("## description");
lines.add("###Syntax");
lines.add("SYNTAX:\n\tSHOW TABLES [FROM] database");
lines.add("####Parameter");
lines.add(">table_name");
lines.add("## example");
lines.add("show tables;");
lines.add("### Exam1");
lines.add("exam1");
lines.add("## keyword");
lines.add("SHOW, TABLES");
lines.add("## url");
lines.add("http://www.baidu.com");
MarkDownParser parser = new MarkDownParser(lines);
Map<String, Map<String, String>> map = parser.parse();
Assert.fail("No exception throws.");
Assert.assertNotNull(map.get("SHOW TABLES"));
Assert.assertEquals(" SHOW TABLES\n", map.get("SHOW TABLES").get("name"));
Assert.assertEquals("Syntax\nSYNTAX:\n\tSHOW TABLES [FROM] database\nParameter\n>table_name\n", map.get("SHOW TABLES").get("description"));
Assert.assertEquals("show tables;\n Exam1\nexam1\n", map.get("SHOW TABLES").get("example"));
Assert.assertEquals("SHOW, TABLES\n", map.get("SHOW TABLES").get("keyword"));
Assert.assertEquals("http://www.baidu.com\n", map.get("SHOW TABLES").get("url"));
}
@Test
public void testEmptyTitle() throws UserException {
List<String> lines = Lists.newArrayList();