Re: [DOCS] Further Clarification request - Mailing list pgsql-docs

From David G. Johnston
Subject Re: [DOCS] Further Clarification request
Date
Msg-id CAKFQuwbv0RzFCtRUL+5VwVPOgjE4aPW0iPtD-nQQhTPzD9huHQ@mail.gmail.com
Whole thread Raw
In response to [DOCS] Further Clarification request  (jym@outlook.com)
Responses Re: [DOCS] Further Clarification request
List pgsql-docs
On Wed, Aug 9, 2017 at 6:25 AM, <jym@outlook.com> wrote:
The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/9.6/static/sql-prepare.html
Description:

https://www.postgresql.org/docs/9.6/static/sql-prepare.html

The first example:  I&#39;d like to see Hunter&#39;s Valley in the execute line as
escaping isn&#39;t mentioned on the page or its links.
Just a suggestion to help us beginners understand how things work.

​This is one of hundreds of documentation examples that include literals.  Why is this one special that it needs to provide an example of a literal containing ​a single quote that requires escaping?

The SQL Command section of the docs properly presumes the reader has significant familiarity with writing SQL queries in PostgreSQL and is looking either for understanding what the different kinds of commands are or, more commonly, needs a refresher as to the exact syntax for less often used commands.  

More precisely, the vast majority of the docs assume you've read "Chapter 4. SQL Syntax".

David J.

pgsql-docs by date:

Previous
From: jym@outlook.com
Date:
Subject: [DOCS] Further Clarification request
Next
From: Jym Morton
Date:
Subject: Re: [DOCS] Further Clarification request