search

ArangoDB-Community / pyArango

Python Driver for ArangoDB with built-in validation
https://pyarango.readthedocs.io/en/latest/
Apache License 2.0
238 stars 90 forks source link

Collection: reformat doc-strings to follow PEP 257 #240

Closed pedramardakani closed 1 year ago

pedramardakani commented 1 year ago

This commit reformats the doc-strings in the 'collection.py' file. Also, fixed some typos and misspellings. The doc-strings are now capitalized, and the 'arguments' and 'keywords' are sandwiched between single quotations.

[1] https://peps.python.org/pep-0257/

I read the contributing guidelines which said I should open pull requests to the dev branch if it is not a critical merge. But it failed to merge automatically. So I opened it for this one which works out fine. Is it OK or should I just retry with using dev as my base branch?

Thanks for all the good work 👍

pedramardakani commented 1 year ago

Hi there 👋 I'd appreciate if you let me know this is actually helpful. If so, I can reformat the other doc-strings as well 🍻

tariqdaouda commented 1 year ago

Just merged it into dev. Yes I think it's useful, it makes everything cleaner.