Re: [PATCH 1/2] core: Allow NULL text search()

[Iago Toral <itoral igalia com>]

On Thu, 03 Feb 2011 09:51:30 +0100, "Juan A." Suárez Romero 
<jasuarez igalia com> wrote:
> On Thu, 2011-02-03 at 07:15 +0000, Iago Toral wrote:
> > If @text is NULL then no text filter will be applied, and thus, no
> >  media items from @source will be filtered. If @source does not
> > support
> >  NULL-text search operations it should notify the client by setting
> > the
> >  error parameter in @callback.
>
>
> Wouldn't it better to say "[...] NULL-text search operations it will
> notify the client [...]" ?
>
> Documentation is explaining what the function does, not what it 
> should
> do.

I think "should" is the correct wording because we cannot ensure it 
will happen: plugin developers are the ones who *should* do that, and 
they are expected to do it, but we cannot guarantee they do that in the 
end, so should looks more appropriate to me in this context.

Iago