Minor fix in pg_buffercache_evict documentation

Started by Ashutosh Bapatabout 1 year ago2 messageshackers
Jump to latest
#1Ashutosh Bapat
ashutosh.bapat@enterprisedb.com

Hi All,
All the functions in pg_buffercache module have their names suffixed
with () and also use <function> tag in the documentation, except
pg_buffercache_evict(). PFA patch to fix the style. With this change,
the index entry and the section tile is displayed as "The
pg_buffercache_evict() Function" instead of "The pg_buffercache_evict
Function", which looks consistent with other function entries and
section headers.

This seems to be the only place where pg_buffercache_evict does not
have suffix ().

--
Best Wishes,
Ashutosh Bapat

Attachments:

0001-Fix-title-in-pg_buffercache_evict-documenta-20250131.patchtext/x-patch; charset=US-ASCII; name=0001-Fix-title-in-pg_buffercache_evict-documenta-20250131.patchDownload+1-2
#2Daniel Gustafsson
daniel@yesql.se
In reply to: Ashutosh Bapat (#1)
Re: Minor fix in pg_buffercache_evict documentation

On 31 Jan 2025, at 07:03, Ashutosh Bapat <ashutosh.bapat.oss@gmail.com> wrote:

Hi All,
All the functions in pg_buffercache module have their names suffixed
with () and also use <function> tag in the documentation, except
pg_buffercache_evict(). PFA patch to fix the style. With this change,
the index entry and the section tile is displayed as "The
pg_buffercache_evict() Function" instead of "The pg_buffercache_evict
Function", which looks consistent with other function entries and
section headers.

This seems to be the only place where pg_buffercache_evict does not
have suffix ().

I agree with this fix so I've applied it to master backpatched to v17 where
pg_buffercache_evict was introduced. Thanks!

--
Daniel Gustafsson