search

morrolinux / subito-it-searcher

searcher for subito.it
100 stars 36 forks source link

Add docstrings #32

Closed daqh closed 1 year ago

daqh commented 1 year ago

Add docstrings with a brief description to any function.

morrolinux commented 1 year ago

Good idea. Thanks!

daqh commented 1 year ago

@morrolinux, I'm also working on implementing tests. But there are significant changes that need to be made to make it happen.

For instance, the current syntax to run the command is:

python3 subito-searcher.py --addtoken [YOUR_API_TOKEN] --addchatid [YOUR_CHANNEL_NAME]

But since the name of the main file is subito-searcher, it can't be easily imported: https://stackoverflow.com/questions/8350853/how-to-import-module-when-module-name-has-a-dash-or-hyphen-in-it/53516983#53516983

So I'm going to rename the file according to the PEP 8's naming conventions for packages & modules in subitosearcher.

And so the syntax for the command will become:

python3 subitosearcher.py --addtoken [YOUR_API_TOKEN] --addchatid [YOUR_CHANNEL_NAME]

Let me know if you agree with these changes and if I can proceed, thank you.