Re: python bindings doc missing part

Subject: Re: python bindings doc missing part

Date: Mon, 29 Sep 2025 21:45:17 +0200

To: Floris Bruynooghe, David Bremner, notmuch@notmuchmail.org

Cc:

From: Andrea Trentini


I'm not familiar with the python doc generator (I'm more a Javadoc type) so I cannot help you, but I
believe every public method should be present in the doc, and if some public method is not
documented (and thus skipped by the doc generator)... it should be documented ;)

On 29/09/2025 21:17, Floris Bruynooghe wrote:
> Certainly not intentional.
> 
> Haven't tried yet but maybe doc/python-bindings.rst needs the
> :undoc-members: option:
> https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-undoc-members
> 
> Cheers,
> Floris
> 
> On Fri 26 Sep 2025 at 07:22 -0300, David Bremner wrote:
> 
>> Andrea Trentini <andrea.trentini@unimi.it> writes:
>>
>>> Hi,
>>> is it true that in the python binding doc (https://notmuchmail.org/doc/latest/python-bindings.html)
>>> some methods are missing?
>>>
>>> e.g., there is no ref to the "threads" method of Database class
>>>
>>
>> Maybe Floris can clarify if this is intentional or not.
>>
>> d

-- 
Andrea Trentini ⠠⠵ - http://atrent.it - public key ID: 0xA7A91E3B - Dip.to di Informatica -
Università degli Studi di Milano
Cittadinanza Digitale e Tecnocivismo -
https://www.ledizioni.it/prodotto/cittadinanza-digitale-tecnocivismo -
https://edizionithemis.it/catalogo/digitale-e-societa/dal-tecnocivismo-alla-cittadinanza-digitale
Sistemi Embedded -
https://www.ledizioni.it/prodotto/a-carraturo-a-trentini-sistemi-embedded-teoria-pratica
OpenPGP_0x72C15962A7A91E3B.asc (application/pgp-keys)
OpenPGP_signature.asc (application/pgp-signature)
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: