| 19 | | 2. The function has a complete docstring. The docstring should clearly describe what the function does, what each argument should be, and what the function returns. If necessary, it should also contain a reference. Since many of these functions are named after prolific people, the docstring should be descriptive enough to disambiguate between all of the procedures that might have a similar name. Between the docstring and the reference, even an inexperienced user should not have to go Googling to find out what the function does. |
| | 19 | 2. The function has a complete docstring. The docstring should clearly describe what the function does, what each argument should be, and what the function returns. If necessary, it should also contain a reference. Since many of these functions are named after prolific people, the docstring should be descriptive enough to disambiguate between all of the procedures that might have a similar name. Between the docstring and the reference, even an inexperienced user should not have to go Googling to find out what the function does. A few lines of example code should be included if they can be kept to "a few lines." |
