nir
Method descriptions missing from Sounds Modules
I'm starting to get interested in exploring audio in Python and was excited to discover the capabilities of your Jupylet project.
But I've just realized that although the documentation is extensive, many of the classes in the Sound and related modules only have the attributes defined, not the methods. Is this an oversight, or because they are waiting updating for the latest code changes or just because you have not got around to documenting them yet?
I note that the code itself is quite well documented, so perhaps there is an issue with documentation not getting automatically generated from the docstrings correctly?
I know that I can find out basic information about the classes using the Python "help" function but this does give any explanation of the methods, just the bare bones of class definitions.
Anyway, you're the expert and I'm only guessing but if you would like help in this area, then I've got the time (if only limited expertise) so I could have a go at helping with documentation.
If the code is documented but these docstrings do not appear in the online documentation it could indeed indicate a problem in the documentation setup. if you are willing to look into that that would be awesome.
It seems on further investigation that the problem is just that the docstrings are incomplete. I think that I can generate these for you, so will have a go at that shortly. We're away for a long weekend right now but I'll get back to the task next week.
On Fri, 3 May 2024, 11:16 Nir Aides, @.***> wrote:
If the code is documented but these docstrings do not appear in the online documentation it could indeed indicate a problem in the documentation setup. if you are willing to look into that that would be awesome.
— Reply to this email directly, view it on GitHub https://github.com/nir/jupylet/issues/44#issuecomment-2092713414, or unsubscribe https://github.com/notifications/unsubscribe-auth/AUEHXT2FQBQQXBZFWSCAYYLZANPZBAVCNFSM6AAAAABHD46SVSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJSG4YTGNBRGQ . You are receiving this because you authored the thread.Message ID: @.***>
I've now created a full set of docsstrings for all classes and methods in the /jupylet/audio/sound.py file with help of Chat GPT and then pasted them in by hand to the souce code. No python code was pasted back in from Chat GPT, so the original code should be preserved as it was unless I made a typo in editing.
Generally I've preserved the content of original docstrings where they existed and incorporated original single line comments within new docstrings.
I'm not experienced at setting up GitHub so that I can insert/update code, so I'm attaching the result as a file attachment here - but this has to be done as a .txt file so I've just changed the extension.
Jupylet Sound - Docstrings.txt
Please do refer any problems back to me.
I think you need to create a pull request, but I'm not familiar with the procedure either. why don't you ask chatgpt how to do it and this way your contribution will be properly recorded ?