refactor func-matching.sgml, make regexp* function more readable - Mailing list pgsql-hackers

From jian he
Subject refactor func-matching.sgml, make regexp* function more readable
Date
Msg-id CACJufxFuk9P=P4=BZ=qCkgvo6im8aL8NnCkjxx2S2MQDWNdouw@mail.gmail.com
Whole thread Raw
List pgsql-hackers
hi.

https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-POSIX-REGEXP

section3 way too big.
The first big part is all these (regexp*) functions, the second part
is  (9.7.3.1. Regular Expression Details )

Please check the attached refactoring. output sample picture also attached.

All these functions (regexp_count, regexp_instr, regexp_like, regexp_match,
regexp_matches, regexp_replace, regexp_split_to_array, regexp_split_to_table,
regexp_substr) are explained/described one after another, which makes the
section (9.7.3 first part) feels a bit condensed.

So I’ve split them up and enclosed each in its own <sect4> section.
I used <synopsis> to mark up each function’s syntax, followed by a detailed
description.  Since each function’s explanation is quite long, using <sect4> to
separate them seems more reasonable.

we could use <table> to group them, like
https://www.postgresql.org/docs/current/functions-json.html#SQLJSON-QUERY-FUNCTIONS
but we have many functions here, using <sect4> would be better than <table>.

Attachment

pgsql-hackers by date:

Previous
From: Michael Paquier
Date:
Subject: Re: Improved TAP tests by replacing sub-optimal uses of ok() with better Test::More functions
Next
From: jian he
Date:
Subject: Re: [PATCH] Add pg_get_trigger_ddl() to retrieve the CREATE TRIGGER statement