Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Craig Ringer
On 16 March 2016 at 01:02, Corey Huinker wrote: > #1 git grep is a helpful reflex for discovering examples on my own, but it > requires that I have a term to search on in the first place, and too often > I don't know what I don't know. > Yep. This can be painful when

Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Corey Huinker
On Tue, Mar 15, 2016 at 4:38 PM, Álvaro Hernández Tortosa wrote: > > I started a similar thread with probably similar concerns: > http://www.postgresql.org/message-id/56d1a6aa.6080...@8kdata.com > > I believe this effort should be done. I added to my TODO list to >

Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Álvaro Hernández Tortosa
I started a similar thread with probably similar concerns: http://www.postgresql.org/message-id/56d1a6aa.6080...@8kdata.com I believe this effort should be done. I added to my TODO list to compile a list of used functions in a selection of picked extensions to use that as a starting

Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Corey Huinker
On Tue, Mar 15, 2016 at 1:35 PM, Joshua D. Drake wrote: > On 03/15/2016 10:30 AM, Corey Huinker wrote: > >> >> On Tue, Mar 15, 2016 at 1:19 PM, Shulgin, Oleksandr >> > >> wrote: >> >> There's also a

Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Joshua D. Drake
On 03/15/2016 10:30 AM, Corey Huinker wrote: On Tue, Mar 15, 2016 at 1:19 PM, Shulgin, Oleksandr > wrote: There's also a good deal of README files in the source tree, so I would add: 4. find src -name 'README*'

Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Corey Huinker
On Tue, Mar 15, 2016 at 1:19 PM, Shulgin, Oleksandr < oleksandr.shul...@zalando.de> wrote: > There's also a good deal of README files in the source tree, so I would > add: > > 4. find src -name 'README*' > That too. But README's don't show up (easily) in a google search, so they elude discovery.

Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Corey Huinker
> > > I think this is all great. You may find some automated assistance from > doxygen.postgresql.org . > > Sincerely, > > JD doxygen is great as far as it goes, but it does a great job of separating function definition from the comment explaining the function, so I have to drill into the raw

Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Shulgin, Oleksandr
On Tue, Mar 15, 2016 at 6:02 PM, Corey Huinker wrote: > Over the past few months, I've been familiarizing myself with postgres > server side programming in C. > > My attempts to educate myself were slow and halting. The existing server > side programming documentation

Re: [HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Joshua D. Drake
On 03/15/2016 10:02 AM, Corey Huinker wrote: Some of these things may seem obvious/trivial to you. I would argue that they're only obvious in retrospect, and the more obvious-to-you things we robustly document, the quicker we accumulate programmers who are capable of agreeing that it's obvious,

[HACKERS] Soliciting Feedback on Improving Server-Side Programming Documentation

2016-03-15 Thread Corey Huinker
Over the past few months, I've been familiarizing myself with postgres server side programming in C. My attempts to educate myself were slow and halting. The existing server side programming documentation has some examples, but those examples didn't show me how do what I wanted to do, and my