git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: Google "Season of Docs"

From
KJKapil Jain <jkapil.cs@gmail.com>
Date
Mar 31, 2019, 06:41 UTC
Message-ID
<CAMknYEP2m7fJ9o5dybEibmMwJJ9-wMStThwU0YN6f_QZzK=z=w@mail.gmail.com>
In-Reply-To
<572677cc-eef3-345b-e970-cd6cc80e8e96@iee.org>
On Sat, Mar 30, 2019 at 10:48 PM Philip Oakley <philipoakley@iee.org> wrote:
Show 5 quoted lines
>
> * Developers rarely want to write documentation (it's too obvious to them)
> -- Our code base has become larger than the average brain-full, maybe
> that (developer education) also could also benefit from some further
> structural documentation.

by developer documentation you mean, a doc explaining what each function does ? agreed, such developer education will help a lot. i am currently trying to do that for `pretty.c`

> -- if stack-overflow is the go-to source for 'real' users, why not mine
> that source.

this point is unclear, please elaborate. I mean stack overflow is searchable already, what kind of mining are we talking about ?

Previous: Philip OakleyNext: Philip Oakley
Message 2 of 5 in “Google "Season of Docs"”
  1. Philip OakleyMar 30, 2019
  2. Kapil JainMar 31, 2019
  3. Philip OakleyMar 31, 2019
  4. Thomas GummererMar 31, 2019
  5. Philip OakleyApr 1, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.