xuefuz commented on issue #8340: [FLINK-12395][table] Add more detailed javadoc for getDescription() and getDetailedDescription() in catalog object interfaces URL: https://github.com/apache/flink/pull/8340#issuecomment-561327811 > Hi @xuefuz , https://issues.apache.org/jira/browse/FLINK-12395 contains the discussion with @twalthr and @dawidwys > > What do you mean by "DDL output"? > > I think the output can depend on either the client or the object itself. The latter one will actually be easier and more controllable in a central place. In this case, `getDescription()` and `getDetailedDescription()` are similar to `toString()` of an object, and "DESCRIBE" is like a print out. I guess I had concern about comments like _It is shown to users when they run "DESCRIBE EXTENDED" in SQL_. That might be true or false, depending on UI implementation, but the API cannot dictate what a UI will do. That's what I meant by coupling API comments with DDL UI behavior. Otherwise, the PR looks good.
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
