Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
gh-38117: Add small examples of common docstring styles
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes #12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes #12345". --> which I think are already established. But it is good to recommend preferred styles to keep docstrings in consistent styles. motivated by the comment: #37821 (comment) ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [x] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> #38068 (merged here) URL: #38117 Reported by: Kwankyu Lee Reviewer(s): gmou3, Kwankyu Lee
- Loading branch information