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.


Reply via email to