Minor fix in pg_buffercache_evict documentation

Started by Ashutosh Bapat12 months ago2 messages

ashutosh.bapat.oss@gmail.com

12 months ago

1 attachment(s)

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

From 38c52ce05adbc625f547086e818bf3c137af339b Mon Sep 17 00:00:00 2001
From: Ashutosh Bapat <ashutosh.bapat.oss@gmail.com>
Date: Fri, 31 Jan 2025 11:22:32 +0530
Subject: [PATCH] Fix title in pg_buffercache_evict() documentation

Like entries of other functions, use <function> tag instead of <structname> and
add () suffix to the function name.

Author: Ashutosh Bapat
---
 doc/src/sgml/pgbuffercache.sgml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml
index 4b90eefc0b0..802a5112d77 100644
--- a/doc/src/sgml/pgbuffercache.sgml
+++ b/doc/src/sgml/pgbuffercache.sgml
@@ -365,7 +365,7 @@
  </sect2>
 
  <sect2 id="pgbuffercache-pg-buffercache-evict">
-  <title>The <structname>pg_buffercache_evict</structname> Function</title>
+  <title>The <function>pg_buffercache_evict()</function> Function</title>
   <para>
    The <function>pg_buffercache_evict()</function> function takes a buffer
    identifier, as shown in the <structfield>bufferid</structfield> column of

base-commit: f41d8468ddea34170fe19fdc17b5a247e7d3ac78
-- 
2.34.1

Daniel Gustafsson

daniel@yesql.se

12 months ago

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