Re: Minor comment improvements in tablecmds.c - Mailing list pgsql-hackers

From Alvaro Herrera
Subject Re: Minor comment improvements in tablecmds.c
Date
Msg-id 20140225184427.GY4759@eldon.alvh.no-ip.org
Whole thread Raw
In response to Minor comment improvements in tablecmds.c  (Etsuro Fujita <fujita.etsuro@lab.ntt.co.jp>)
Responses Re: Minor comment improvements in tablecmds.c  (Robert Haas <robertmhaas@gmail.com>)
List pgsql-hackers
Etsuro Fujita wrote:
> This is a small patch to improve comments in tablecmds.c.  Please find
> attached a patch.

I find both patched and unpatched to be pretty illegible.  How about
something like

>  /*
> - * Execute ALTER TABLE/INDEX/SEQUENCE/VIEW/FOREIGN TABLE RENAME
> + * Execute ALTER <relation type> RENAME
> + *         This routine supports tables, indexes, sequences, views,
> + *        and foreign tables
>   */

and the two other ones with something like this:

>      /*
> -     * Grab an exclusive lock on the target table, index, sequence or view,
> -     * which we will NOT release until end of transaction.
> +     * Grab an exclusive lock on the target relation,
> +      * which we will NOT release until
> +     * end of transaction.

-- 
Álvaro Herrera                http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services



pgsql-hackers by date:

Previous
From: Robert Haas
Date:
Subject: Re: Minor comment improvements in tablecmds.c
Next
From: Josh Berkus
Date:
Subject: Re: jsonb and nested hstore