arina-ielchiieva commented on issue #2047: DRILL-7675: Work around for partitions sender memory use URL: https://github.com/apache/drill/pull/2047#issuecomment-609650653 @paul-rogers as you know before Drill project had a document writer who was adding documentation to the site (https://drill.apache.org/docs/). Now it's up to the Drill contributor to ensure if his work is documented or not. `OptionDescription` information is used on Drill Web UI to describe options, so of course it is pretty useful if would have nice description. You can also add your description to the Drill site (create the PR, got it reviewed and then regenerate the site, there is an instruction how it should be done - https://github.com/apache/drill/tree/gh-pages-master/). Why I have asked you to add java doc? I don't know how and when you are going to document new option. But you wrote really nice description and I did not want it to be lost, having it at least in java doc would help people in future who might be reverse-engineering this code or even users who would need to understand how this option works. Frankly saying, having this documentation section in PR template, does not make any difference since who do we expect to transfer documentation to the Drill web site? Developer who created the PR? I did not see much documentation PRs expect of @vvysotskyi who added info about Drill Metastore. cc @cgivre
---------------------------------------------------------------- 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
