You can file a JIRA case if you like, but if you have a fix, and since it’s just documentation (i.e. can’t break anything) I think a pull request will be sufficient.
Same goes for missing / wrong documentation anywhere else in Calcite. We’ll check it, correct it, fix the spelling and formatting, etc. A contribution helps us get started. Any by the way, at Apache we regard all contributions to the community — documentation, answering questions on mailing lists and at stack overflow, giving conference talks, writing tests — to be as valuable as writing code, and we often recognize such contributors by making them committers. Julian > On Oct 25, 2017, at 6:00 AM, Alexey Roytman <[email protected]> wrote: > > Shall I fill a JIRA task for this [documentation] issue? > > > On 10/22/2017 08:35 PM, Julian Hyde wrote: >> As you can see from ScannableTableTest.getFilter, the table removes >> any filters it can apply. >> >> I.e. the @param javadoc is wrong. >> >> Julian >> >> >> On Sun, Oct 22, 2017 at 5:44 AM, Alexey Roytman >> <[email protected]> wrote: >>> The documentation section for ProjectableFilterableTable.scan() is somewhat >>> self-contradicting: >>> ... >>> * If the table can implement a particular filter, it should remove that >>> * filter from the list. >>> * If it cannot implement a filter, it should leave it in the list. >>> ... >>> * @param filters Mutable list of filters. The method should remove from >>> the >>> * list any filters that it cannot apply. >>> ... >>> >>> The contradiction comes from the method description and the @param for the >>> 'filters' argument. >>> >>> - Alexey. >>> >
