messense
doc: clean() with examples explaining how to use the arguments
From the current docu of clean() it is not clear to me how to use the several arguments available in that function.
Examples in the docu would help me a lot.
https://github.com/messense/nh3/blob/9d73a463678fe3874d3934a6714d3dbb5ef398e1/src/lib.rs#L8-L46
Sorry no example ATM, PR are welcome!
Note that generated api reference is here: https://nh3.readthedocs.io/en/stable/#nh3.clean
Hello messense, thank you for the reply.
Sorry no example ATM
No, need to say sorry.
PR are welcome!
I am not able to provide that because I don't understand the arguments in questions.
From maintainer to maintainer: Don't use that phrase. It just drives contributors away because the subtext always is "You lazy user, how dare you to ask for something and not solving it yourself." And it doesn't matter how you (as a sender) mean it. It only counts how the receiver understands it. Please be more kind to your contributors, even those with "stupid" questions, to support FOSS.
Note that generated api reference is here: https://nh3.readthedocs.io/en/stable/#nh3.clean
Thanks for that hint.
I am not able to provide that because I don't understand the arguments in questions.
FWIW since nh3 is a thin layer over ammonia, ammonia's API docs can generally be used as basis to try and understand the Python side.
Although you need to go through the mapping (in the code), and that assumes it's documented in a way that's understandable on the ammonia side, which is usually the case (as pretty much all methods have examples) but not always (as examples may not show all edge cases).
