You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@calcite.apache.org by "Julian Hyde (JIRA)" <ji...@apache.org> on 2019/05/07 17:54:00 UTC

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

Julian Hyde created CALCITE-3053:
------------------------------------

             Summary: Add a test to ensure that all functions are documented in the SQL reference
                 Key: CALCITE-3053
                 URL: https://issues.apache.org/jira/browse/CALCITE-3053
             Project: Calcite
          Issue Type: Bug
            Reporter: Julian Hyde
            Assignee: Julian Hyde


Add a test to ensure that all functions are documented in the [SQL reference|https://calcite.apache.org/docs/reference.html].

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.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)