boolean and bool in documentation - Mailing list pgsql-hackers

From Masahiko Sawada
Subject boolean and bool in documentation
Date
Msg-id CAD21AoCuGh0Tyd8hDU7nKZRdH_WMikzO9tLsHfnfHAR2PDST=g@mail.gmail.com
Whole thread Raw
Responses Re: boolean and bool in documentation  (Bruce Momjian <bruce@momjian.us>)
List pgsql-hackers
HI,

I realized that 'boolean' and 'bool' are mixed as SQL data type in the
documentation. Here is the quick check result;

$ git grep -c "<type>bool</type>" doc
doc/src/sgml/bki.sgml:1
doc/src/sgml/btree-gin.sgml:1
doc/src/sgml/catalogs.sgml:88
doc/src/sgml/datatype.sgml:1
doc/src/sgml/ecpg.sgml:2
doc/src/sgml/func.sgml:20
doc/src/sgml/gin.sgml:2
doc/src/sgml/monitoring.sgml:1
doc/src/sgml/plpython.sgml:1
doc/src/sgml/xfunc.sgml:1
doc/src/sgml/xml2.sgml:2

 $ git grep -c "<type>boolean</type>" doc
doc/src/sgml/adminpack.sgml:2
doc/src/sgml/auto-explain.sgml:6
doc/src/sgml/catalogs.sgml:23
doc/src/sgml/config.sgml:93
doc/src/sgml/cube.sgml:10
doc/src/sgml/datatype.sgml:7
doc/src/sgml/ecpg.sgml:2
doc/src/sgml/extend.sgml:2
doc/src/sgml/func.sgml:102
doc/src/sgml/hstore.sgml:2
doc/src/sgml/information_schema.sgml:1
doc/src/sgml/intarray.sgml:5
doc/src/sgml/isn.sgml:3
doc/src/sgml/json.sgml:2
doc/src/sgml/ltree.sgml:18
doc/src/sgml/monitoring.sgml:2
doc/src/sgml/pgbuffercache.sgml:1
doc/src/sgml/pgprewarm.sgml:1
doc/src/sgml/pgrowlocks.sgml:1
doc/src/sgml/pgstatstatements.sgml:2
doc/src/sgml/pgtrgm.sgml:5
doc/src/sgml/plperl.sgml:1
doc/src/sgml/plpgsql.sgml:1
doc/src/sgml/plpython.sgml:2
doc/src/sgml/queries.sgml:1
doc/src/sgml/ref/alter_subscription.sgml:2
doc/src/sgml/ref/alter_view.sgml:1
doc/src/sgml/ref/copy.sgml:1
doc/src/sgml/ref/create_cast.sgml:1
doc/src/sgml/ref/create_policy.sgml:2
doc/src/sgml/ref/create_rule.sgml:1
doc/src/sgml/ref/create_subscription.sgml:4
doc/src/sgml/ref/create_table.sgml:2
doc/src/sgml/ref/create_type.sgml:1
doc/src/sgml/ref/create_view.sgml:1
doc/src/sgml/ref/delete.sgml:1
doc/src/sgml/ref/insert.sgml:1
doc/src/sgml/ref/select.sgml:2
doc/src/sgml/ref/update.sgml:1
doc/src/sgml/sepgsql.sgml:2
doc/src/sgml/spgist.sgml:1
doc/src/sgml/syntax.sgml:1
doc/src/sgml/typeconv.sgml:2
doc/src/sgml/xfunc.sgml:1
doc/src/sgml/xindex.sgml:1
doc/src/sgml/xoper.sgml:2

AFAICS there seems not to be explicit rules and policies for usage of
'boolean' and 'bool'. We use 'bool' for colum data type of almost
system catalogs but use 'boolean' for some catalogs (pg_pltemplate and
pg_policy). The same is true for functions and system views. Is it
better to unify them into 'boolean' for consistency and so as not
unnecessarily confuse users? FYI the name of boolean type is 'boolean'
in the standard.

Regards,

--
Masahiko Sawada
NIPPON TELEGRAPH AND TELEPHONE CORPORATION
NTT Open Source Software Center


pgsql-hackers by date:

Previous
From: Michael Banck
Date:
Subject: Re: Progress reporting for pg_verify_checksums
Next
From: Bernd Helmle
Date:
Subject: Re: Progress reporting for pg_verify_checksums