public inbox for [email protected]help / color / mirror / Atom feed
Documentation for varbit is missing size parameter 10+ messages / 5 participants [nested] [flat]
* Documentation for varbit is missing size parameter @ 2018-03-11 04:43 PG Doc comments form <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: PG Doc comments form @ 2018-03-11 04:43 UTC (permalink / raw) To: [email protected]; +Cc: [email protected] The following documentation comment has been logged on the website: Page: https://www.postgresql.org/docs/10/static/datatype.html Description: The documentation for the varbit data type is missing the size parameter "[ (n) ]". ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-03-16 04:17 Euler Taveira <[email protected]> parent: PG Doc comments form <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: Euler Taveira @ 2018-03-16 04:17 UTC (permalink / raw) To: [email protected]; [email protected] 2018-03-11 1:43 GMT-03:00 PG Doc comments form <[email protected]>: > The documentation for the varbit data type is missing the size parameter "[ > (n) ]". > Good catch! It seems to be an oversight in commit 768b647ead78d0d63915c1708cad13c2468f9440. The attached patch adds it. -- Euler Taveira Timbira - http://www.timbira.com.br/ PostgreSQL: Consultoria, Desenvolvimento, Suporte 24x7 e Treinamento Attachments: [text/x-patch] doc2.diff (468B, 2-doc2.diff) download | inline diff: diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml index 9aa9b28..53059d5 100644 --- a/doc/src/sgml/datatype.sgml +++ b/doc/src/sgml/datatype.sgml @@ -60,7 +60,7 @@ <row> <entry><type>bit varying [ (<replaceable>n</replaceable>) ]</type></entry> - <entry><type>varbit</type></entry> + <entry><type>varbit [ (<replaceable>n</replaceable>) ]</type></entry> <entry>variable-length bit string</entry> </row> ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-03-30 15:18 Bruce Momjian <[email protected]> parent: Euler Taveira <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: Bruce Momjian @ 2018-03-30 15:18 UTC (permalink / raw) To: Euler Taveira <[email protected]>; +Cc: [email protected]; [email protected] On Fri, Mar 16, 2018 at 01:17:04AM -0300, Euler Taveira wrote: > 2018-03-11 1:43 GMT-03:00 PG Doc comments form <[email protected]>: > > The documentation for the varbit data type is missing the size parameter "[ > > (n) ]". > > > Good catch! It seems to be an oversight in commit > 768b647ead78d0d63915c1708cad13c2468f9440. The attached patch adds it. Wow, that commit is from 2004. Patch applied and backpatched to v10. -- Bruce Momjian <[email protected]> http://momjian.us EnterpriseDB http://enterprisedb.com + As you are, so once was I. As I am, so you will be. + + Ancient Roman grave inscription + ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-03-30 15:39 Magnus Hagander <[email protected]> parent: Bruce Momjian <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: Magnus Hagander @ 2018-03-30 15:39 UTC (permalink / raw) To: Bruce Momjian <[email protected]>; +Cc: Euler Taveira <[email protected]>; [email protected]; [email protected] On Fri, Mar 30, 2018 at 5:18 PM, Bruce Momjian <[email protected]> wrote: > On Fri, Mar 16, 2018 at 01:17:04AM -0300, Euler Taveira wrote: > > 2018-03-11 1:43 GMT-03:00 PG Doc comments form <[email protected]>: > > > The documentation for the varbit data type is missing the size > parameter "[ > > > (n) ]". > > > > > Good catch! It seems to be an oversight in commit > > 768b647ead78d0d63915c1708cad13c2468f9440. The attached patch adds it. > > Wow, that commit is from 2004. Patch applied and backpatched to v10. > If it goes all the way back to 2004, why not backpatch further? -- Magnus Hagander Me: https://www.hagander.net/ <http://www.hagander.net/; Work: https://www.redpill-linpro.com/ <http://www.redpill-linpro.com/; ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-03-30 16:26 Bruce Momjian <[email protected]> parent: Magnus Hagander <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: Bruce Momjian @ 2018-03-30 16:26 UTC (permalink / raw) To: Magnus Hagander <[email protected]>; +Cc: Euler Taveira <[email protected]>; [email protected]; [email protected] On Fri, Mar 30, 2018 at 05:39:46PM +0200, Magnus Hagander wrote: > On Fri, Mar 30, 2018 at 5:18 PM, Bruce Momjian <[email protected]> wrote: > > On Fri, Mar 16, 2018 at 01:17:04AM -0300, Euler Taveira wrote: > > 2018-03-11 1:43 GMT-03:00 PG Doc comments form <[email protected]>: > > > The documentation for the varbit data type is missing the size > parameter "[ > > > (n) ]". > > > > > Good catch! It seems to be an oversight in commit > > 768b647ead78d0d63915c1708cad13c2468f9440. The attached patch adds it. > > Wow, that commit is from 2004. Patch applied and backpatched to v10. > > > If it goes all the way back to 2004, why not backpatch further? Uh, I am always debating how important it is to backpatck vs the churn we require of translations of our docs. In this case, it didn't seem worthwhile to have all of those translations try to deal with this change for all those back branches. -- Bruce Momjian <[email protected]> http://momjian.us EnterpriseDB http://enterprisedb.com + As you are, so once was I. As I am, so you will be. + + Ancient Roman grave inscription + ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-03-30 16:28 Magnus Hagander <[email protected]> parent: Bruce Momjian <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: Magnus Hagander @ 2018-03-30 16:28 UTC (permalink / raw) To: Bruce Momjian <[email protected]>; +Cc: Euler Taveira <[email protected]>; [email protected]; [email protected] On Fri, Mar 30, 2018 at 6:26 PM, Bruce Momjian <[email protected]> wrote: > On Fri, Mar 30, 2018 at 05:39:46PM +0200, Magnus Hagander wrote: > > On Fri, Mar 30, 2018 at 5:18 PM, Bruce Momjian <[email protected]> wrote: > > > > On Fri, Mar 16, 2018 at 01:17:04AM -0300, Euler Taveira wrote: > > > 2018-03-11 1:43 GMT-03:00 PG Doc comments form < > [email protected]>: > > > > The documentation for the varbit data type is missing the size > > parameter "[ > > > > (n) ]". > > > > > > > Good catch! It seems to be an oversight in commit > > > 768b647ead78d0d63915c1708cad13c2468f9440. The attached patch adds > it. > > > > Wow, that commit is from 2004. Patch applied and backpatched to v10. > > > > > > If it goes all the way back to 2004, why not backpatch further? > > Uh, I am always debating how important it is to backpatck vs the churn > we require of translations of our docs. In this case, it didn't seem > worthwhile to have all of those translations try to deal with this > change for all those back branches. > > If it's a clean backpatch I'd say it is -- people who are using PostgreSQL 9.6 will be reading the documentation for 9.6 etc, so they will not know about the fix then. If it's not a clean backpatch I can certainly see considering it, but if it's not a lot of effort then I'd say it's definitely worth it. I really don't think considerations for translators of the *docs* are an issue here. If you don't backpatch it, then nobody gets the fix. If you backpatch it, then English readers do get the fix, and translated docs readers *might* get the fix, depending on how they are maintained. It's not like translatable strings where if they change in a backbranch they will revert to English unless the translation is updated -- for the docs, they just don't get the fix. -- Magnus Hagander Me: https://www.hagander.net/ <http://www.hagander.net/; Work: https://www.redpill-linpro.com/ <http://www.redpill-linpro.com/; ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-03-30 16:34 Bruce Momjian <[email protected]> parent: Magnus Hagander <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: Bruce Momjian @ 2018-03-30 16:34 UTC (permalink / raw) To: Magnus Hagander <[email protected]>; +Cc: Euler Taveira <[email protected]>; [email protected]; [email protected] On Fri, Mar 30, 2018 at 06:28:15PM +0200, Magnus Hagander wrote: > On Fri, Mar 30, 2018 at 6:26 PM, Bruce Momjian <[email protected]> wrote: > Uh, I am always debating how important it is to backpatck vs the churn > we require of translations of our docs. In this case, it didn't seem > worthwhile to have all of those translations try to deal with this > change for all those back branches. > If it's a clean backpatch I'd say it is -- people who are using PostgreSQL 9.6 > will be reading the documentation for 9.6 etc, so they will not know about the > fix then. > > If it's not a clean backpatch I can certainly see considering it, but if it's > not a lot of effort then I'd say it's definitely worth it. > > I really don't think considerations for translators of the *docs* are an issue > here. If you don't backpatch it, then nobody gets the fix. If you backpatch it, > then English readers do get the fix, and translated docs readers *might* get > the fix, depending on how they are maintained. It's not like translatable > strings where if they change in a backbranch they will revert to English unless > the translation is updated -- for the docs, they just don't get the fix. My logic is that the more we backpatch, the less likely translators are going to be to keep their docs up-to-date with minor releases since the minor release diff is larger and contains more items that aren't _required_ for correctness. I looked at this patch and thought it was more a stylistic item rather than a correction. Is that right? -- Bruce Momjian <[email protected]> http://momjian.us EnterpriseDB http://enterprisedb.com + As you are, so once was I. As I am, so you will be. + + Ancient Roman grave inscription + ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-03-30 17:31 David G. Johnston <[email protected]> parent: Bruce Momjian <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: David G. Johnston @ 2018-03-30 17:31 UTC (permalink / raw) To: Bruce Momjian <[email protected]>; +Cc: Magnus Hagander <[email protected]>; Euler Taveira <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]> On Friday, March 30, 2018, Bruce Momjian <[email protected]> wrote: > > I looked at this patch and thought it was more a stylistic item rather > than a correction. Is that right? > Looks like a syntax bug fix to me - especially since it is a reference table. Those should be back-patched. David J. ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-03-30 17:34 Bruce Momjian <[email protected]> parent: David G. Johnston <[email protected]> 0 siblings, 1 reply; 10+ messages in thread From: Bruce Momjian @ 2018-03-30 17:34 UTC (permalink / raw) To: David G. Johnston <[email protected]>; +Cc: Magnus Hagander <[email protected]>; Euler Taveira <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]> On Fri, Mar 30, 2018 at 10:31:07AM -0700, David G. Johnston wrote: > On Friday, March 30, 2018, Bruce Momjian <[email protected]> wrote: > > I looked at this patch and thought it was more a stylistic item rather > than a correction. Is that right? > > > Looks like a syntax bug fix to me - especially since it is a reference table. > Those should be back-patched. OK, now backpatched through 9.3. -- Bruce Momjian <[email protected]> http://momjian.us EnterpriseDB http://enterprisedb.com + As you are, so once was I. As I am, so you will be. + + Ancient Roman grave inscription + ^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Documentation for varbit is missing size parameter @ 2018-04-01 15:28 Magnus Hagander <[email protected]> parent: Bruce Momjian <[email protected]> 0 siblings, 0 replies; 10+ messages in thread From: Magnus Hagander @ 2018-04-01 15:28 UTC (permalink / raw) To: Bruce Momjian <[email protected]>; +Cc: David G. Johnston <[email protected]>; Euler Taveira <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]> On Fri, Mar 30, 2018 at 7:34 PM, Bruce Momjian <[email protected]> wrote: > On Fri, Mar 30, 2018 at 10:31:07AM -0700, David G. Johnston wrote: > > On Friday, March 30, 2018, Bruce Momjian <[email protected]> wrote: > > > > I looked at this patch and thought it was more a stylistic item > rather > > than a correction. Is that right? > > > > > > Looks like a syntax bug fix to me - especially since it is a reference > table. > > Those should be back-patched. > > OK, now backpatched through 9.3. > > Thanks! -- Magnus Hagander Me: https://www.hagander.net/ <http://www.hagander.net/; Work: https://www.redpill-linpro.com/ <http://www.redpill-linpro.com/; ^ permalink raw reply [nested|flat] 10+ messages in thread
end of thread, other threads:[~2018-04-01 15:28 UTC | newest] Thread overview: 10+ messages (download: mbox mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2018-03-11 04:43 Documentation for varbit is missing size parameter PG Doc comments form <[email protected]> 2018-03-16 04:17 ` Euler Taveira <[email protected]> 2018-03-30 15:18 ` Bruce Momjian <[email protected]> 2018-03-30 15:39 ` Magnus Hagander <[email protected]> 2018-03-30 16:26 ` Bruce Momjian <[email protected]> 2018-03-30 16:28 ` Magnus Hagander <[email protected]> 2018-03-30 16:34 ` Bruce Momjian <[email protected]> 2018-03-30 17:31 ` David G. Johnston <[email protected]> 2018-03-30 17:34 ` Bruce Momjian <[email protected]> 2018-04-01 15:28 ` Magnus Hagander <[email protected]>
This inbox is served by agora; see mirroring instructions for how to clone and mirror all data and code used for this inbox