Uploaded image for project: 'Calcite'
  1. Calcite
  2. CALCITE-3053

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

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.20.0
    • Component/s: None
    • Labels:
      None

      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.

        Attachments

          Activity

            People

            • Assignee:
              julianhyde Julian Hyde
              Reporter:
              julianhyde Julian Hyde
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: