On 16/12/2025 00:49, [email protected] wrote:


On Dec 14, 2025, at 3:07 PM, via Twisted <[email protected]> wrote:

The last example on this page https://docs.twisted.org/en/ twisted-18.7.0/core/howto/pb-cred.html doesn't work, is that because
...


Yes, this is most likely broken because we don't have test coverage, or even type checking, for our documentation. Sorry for the trouble.

I've used https://sybil.readthedocs.io/en/latest/ for at least one Twisted-based project, it could probably work well here, but no, I don't have time to work on this :'(

The source for this example is here: https://github.com/twisted/twisted/ blob/trunk/docs/core/howto/listings/pb/chatserver.py <https:// github.com/twisted/twisted/blob/trunk/docs/core/howto/listings/pb/ chatserver.py>

Would you have any interest in submitting a small pull request to fix it?  You don't need to add automated test coverage for the example, given that none exists currently, and it might be a hassle to set up a testing environment for that just to fix a couple of small type issues.

...but if you'd like to give Sybil a go for wider impact, please let me know if you hit any problems!

I'd use the unittest integration: https://sybil.readthedocs.io/en/latest/use.html#test-runner-integration

cheers,

Chris

_______________________________________________
Twisted mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/twisted.python.org/
Message archived at 
https://mail.python.org/archives/list/[email protected]/message/Q7NYKRAWTAORDJIUKE47AI2HPWZY7PHO/
Code of Conduct: https://twisted.org/conduct

Reply via email to