Re: Re: BUG #15629: Typo in Documentation

The following bug has been logged on the website:

Bug reference: 15629
Logged by: Shouyu Luo
Email address: syluo1990(at)hotmail(dot)com
PostgreSQL version: 11.0
Operating system: Ubuntu
Description:

/docs/current/ddl-partitioning.html

5.10.5. Partitioning and Constraint Exclusion
Constraint exclusion is only applied during query planning; unlike partition
pruning, it cannot be applied during query execution.

Is it supposed to be "unlike partition pruning, it can be applied during
query execution"?

On Mon, 11 Feb 2019 at 20:49, PG Bug reporting form
<noreply(at)postgresql(dot)org> wrote:
> /docs/current/ddl-partitioning.html
>
> 5.10.5. Partitioning and Constraint Exclusion
> Constraint exclusion is only applied during query planning; unlike partition
> pruning, it cannot be applied during query execution.
>
> Is it supposed to be "unlike partition pruning, it can be applied during
> query execution"?

That's a bit confusing. "it" looks like must have been intended to
reference constraint exclusion, but since partition pruning was
mentioned afterwards, then it makes more sense to apply it to that.

Maybe it would be more clear to write:

Constraint exclusion is only applied during query planning; unlike
partition pruning which can also be applied during query execution.

Small patch doing it that way is attached.

--
David Rowley http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

On Mon, Feb 11, 2019 at 5:25 PM David Rowley
<david(dot)rowley(at)2ndquadrant(dot)com> wrote:
> On Mon, 11 Feb 2019 at 20:49, PG Bug reporting form
> <noreply(at)postgresql(dot)org> wrote:
> > /docs/current/ddl-partitioning.html
> >
> > 5.10.5. Partitioning and Constraint Exclusion
> > Constraint exclusion is only applied during query planning; unlike partition
> > pruning, it cannot be applied during query execution.
> >
> > Is it supposed to be "unlike partition pruning, it can be applied during
> > query execution"?
>
> That's a bit confusing. "it" looks like must have been intended to
> reference constraint exclusion, but since partition pruning was
> mentioned afterwards, then it makes more sense to apply it to that.
>
> Maybe it would be more clear to write:
>
> Constraint exclusion is only applied during query planning; unlike
> partition pruning which can also be applied during query execution.
>
> Small patch doing it that way is attached.

+1

Maybe, the semicolon should be replaced by a comma?

Thanks,
Amit

On 02/11/19 08:18, Amit Langote wrote:
> Maybe, the semicolon should be replaced by a comma?

I agree, and here is a version of the patch with that change.

Regards,
-Chap

The following review has been posted through the commitfest application:
make installcheck-world: not tested
Implements feature: not tested
Spec compliant: not tested
Documentation: tested, passed

This is a simple documentation change for which I do not see any controversy. (As a native speaker, I didn't find the original wording unclear, but if this change widens the audience for which it is clear, that's worthwhile.)

The new status of this patch is: Ready for Committer

hmm, cf app has not seen <5C621F9F(dot)3020307(at)anastigmatix(dot)net> yet ... changing status back until that happens.

The new status of this patch is: Needs review

On Tue, 12 Feb 2019 at 14:21, Chapman Flack <chap(at)anastigmatix(dot)net> wrote:
>
> On 02/11/19 08:18, Amit Langote wrote:
> > Maybe, the semicolon should be replaced by a comma?
>
> I agree, and here is a version of the patch with that change.

Agreed about the comma. Thanks for updating the patch.

--
David Rowley http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

On Tue, Feb 12, 2019 at 03:09:30PM +1300, David Rowley wrote:
> Agreed about the comma. Thanks for updating the patch.

Cool for me, so pushed down to v11.
--
Michael

On Tue, 12 Feb 2019 at 16:04, Michael Paquier <michael(at)paquier(dot)xyz> wrote:
> Cool for me, so pushed down to v11.

Thanks for pushing.

(belated due to being on leave)

--
David Rowley http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

On Mon, Feb 18, 2019 at 01:04:22PM +1300, David Rowley wrote:
> Thanks for pushing.
>
> (belated due to being on leave)

No problem. Hope you had a good rest.
--
Michael