search

gtsystem / lightkube

Modern lightweight kubernetes module for python
https://lightkube.readthedocs.io
MIT License
110 stars 14 forks source link

Include failure conditions in docstrings #72

Open 11xor6 opened 4 months ago

11xor6 commented 4 months ago

You've done a great job with this library and one of the things I most appreciate is the extensive documentation I can get within my editor, including the type hints. However the one thing I find to be missing is the failure conditions. For example what happens when I call Client.get(...) for an object that doesn't exist? Does it return an empty object? None? Throw an exception? The docstring doesn't specify. This means you need to dig into the code to find out what it does and which exceptions it throws. It'd honestly be great if the docstrings specified such conditions.

gtsystem commented 3 weeks ago

I agree with you, this will be nice to have. If you would like to contribute this change it will great.