unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: James Cook <falsifian@falsifian.org>
Cc: notmuch@notmuchmail.org
Subject: Re: API docs: notmuch_database_open_with_config with NULL config
Date: Sat, 15 Apr 2023 15:48:13 -0300	[thread overview]
Message-ID: <87a5z9c782.fsf@minkowski.home> (raw)
In-Reply-To: <2ixwzibg6ljfnlqsuvn7aswiona7nnw4xzbxmp6xbwtxtzxtxp@s2gb7wzl5tg5>

James Cook <falsifian@falsifian.org> writes:

> It is possible that a short note indicating that detailed descriptions
> will follow, placed at the top of the man page and/or at the top of the
> "Functions" section, would have saved me from my impatience. I think I
> do tend to read the first sentence or two of a man page before just
> searching for what I'm looking for. But absent such a note, maybe I can
> be excused for paging through a few screenfuls of API summary and
> assuming that's all there was.

I'm a bit reluctant to invest much effort in the current Doxygen based
API docs (I'm hoping we eventually replace them with something more
compatible with the rest of the sphinx-doc based documentation). On the
other hand if someone else out there is a better Doxygen wrangler than I
and the fix is relatively small, I don't see why we wouldn't apply that
change.

d

      reply	other threads:[~2023-04-15 18:48 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-15 14:09 API docs: notmuch_database_open_with_config with NULL config James Cook
2023-04-15 15:26 ` David Bremner
2023-04-15 16:42   ` James Cook
2023-04-15 18:48     ` David Bremner [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87a5z9c782.fsf@minkowski.home \
    --to=david@tethera.net \
    --cc=falsifian@falsifian.org \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).