[CALCITE-3053] Add a test to ensure that all functions are documented in the SQL reference

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.20.0
• Assignee: Julian Hyde
• Reporter: Julian Hyde
• Created: 07/May/19 17:53
• Updated: 19/Jan/23 02:20
• Resolved: 10/May/19 00:03

Description

Add a test to ensure that all functions are documented in the SQL reference.

The test would would be called DocumentationTest, iterate through all functions and operators in SqlStdOperatorTable and OracleSqlOperatorTable and make sure that there is a line "| functionName ... |" in reference.md.

There are sure to be exceptions. We can exceptions to a comment inside reference.md that is seen by the test but does not appear in the generated web page.

I'll do this after CALCITE-2846, and make sure that Oracle- and MySQL-specific functions are flagged as such.

After CALCITE-3016 we will need to refactor the test a little.

Issue Links

• relates to: CALCITE-5485 Make type conversion documentation consistent with behavior and tests