Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to methods #19

Open
salvo-polizzi opened this issue Mar 19, 2023 · 0 comments
Open

Add documentation to methods #19

salvo-polizzi opened this issue Mar 19, 2023 · 0 comments

Comments

@salvo-polizzi
Copy link
Contributor

I think that could be useful to add some documentation in all methods as a comment.
For example something like that:

def add_book(context: CallbackContext, chat_id: int, isbn: str, title: str, authors: str) -> None:   
"""called in the request of a book or in selling books.
     Add a book in the Books table

        Args:
            context: context passed by the handler
            chat_id: id of the chat of the message
            isbn: isbn of the book to add
            title: title of the book to add
            authors: authors of the book to add"""
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant