search

TeamCodeArena / DeliverEase

DeliverEase is an innovative platform designed to empower delivery partners and foster seamless connections between buyers and sellers without the need for intermediaries.
MIT License
13 stars 17 forks source link

Fixed all pydocstyle errors #106

Closed neelansh27 closed 1 year ago

neelansh27 commented 1 year ago

@SID262000 I've added all the docstrings needed and also modified the one's already existing to fix all pydocstyle errors in the backend #8

SID262000 commented 1 year ago

Please make sure you have run pydocstyle and there aren't any reported issues or warnings. Also, let me know if you've by passed any, will need to investigate more on them. Many Thanks @neelansh27 for taking this up so diligently!

neelansh27 commented 1 year ago

@SID262000 pydocstyle is giving error for docstring in sphinx documentation folder, I'm not sure whether to include that file in the ignored files list in precommit hook since it's a configuration file or add docstrings in that file as well. There are no other files which are giving error or warnings when running pydocstyle. Path of file: docs/conf.py

SID262000 commented 1 year ago

Sphinx doesn't require docstring as Sphinx itself is generated from the docstring we provide. You can add it to ignore during pre-commit checks. cc: @neelansh27

neelansh27 commented 1 year ago

I've added sphinx documentation to the ignored files list in the pre-commit hook. I'm also not facing any errors or warnings while running pydocstyle @SID262000