Hi, When I review a PR for introducing a new SQL grammar into IoTDB, I realize that our SQL documents are confusing contributors.
1. we have several documents under IoTDB-SQL-Language folder, like [1], which introduces some important and frequent grammar. 2. we have a complete SQL reference document [2]. It is definitely that we need to update the document [2] when introducing new SQL grammar. However, when should we update document [1]? I think we need to make a convention. >From my side, [1] is for introducing what features we have. So, for a new query feature, we need to update doc [1] to introduce when to use it, and how to use it. But we can omit some cases that are rarely used. Another choice is removing the document [1], but currently I do not think it is the time because they are more friendly for readers now. [1] https://iotdb.apache.org/UserGuide/Master/IoTDB-SQL-Language/DML-Data-Manipulation-Language.html [2] https://iotdb.apache.org/UserGuide/Master/Appendix/SQL-Reference.html Best, ----------------------------------- Xiangdong Huang School of Software, Tsinghua University 黄向东 清华大学 软件学院
