fix: Fixed few `docstrings` according to the Google Style Guide
What does this PR do?
It is mentioned in the Contributing.md file that the Google Style Guide is used for docstrings. I fixed few inconsistencies according the Style Guide.
Used some of the following ruff checks to automatically find and fix these.
Before submitting
- [x] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
- [x] Did you read the contributor guideline?
- [ ] Did you read our philosophy doc (important for complex PRs)?
- [ ] Was this discussed/approved via a GitHub issue or the forum? Please add a link to it if that's the case.
- [ ] Did you make sure to update the documentation with your changes? Here are the documentation guidelines, and here are tips on formatting docstrings.
- [ ] Did you write any new necessary tests?
Who can review?
@sayakpaul
Thanks for your PR but we don't follow Google style guide for docstrings.
Thanks for your PR but we don't follow Google style guide for docstrings.
Hey, @sayakpaul thanks for the quick review. It is specifically mentioned here that Google Style guide is followed for docstrings 🤔. Irrespective of that, these changes fixes the inconsistent docstrings in the codebase.
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.