diff options
| author | 2021-07-23 08:13:19 +0700 | |
|---|---|---|
| committer | 2021-07-23 08:13:19 +0700 | |
| commit | b6d339e46b2fb445d00a8c78e796ee97296baaa2 (patch) | |
| tree | 28ffba1841eccce2fac54c43f043067d5fbcf171 | |
| parent | Update docstring explanation. (diff) | |
Update docstring's explanation
| -rw-r--r-- | bot/resources/tags/docstring.md | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/bot/resources/tags/docstring.md b/bot/resources/tags/docstring.md index feafecc41..9457b629c 100644 --- a/bot/resources/tags/docstring.md +++ b/bot/resources/tags/docstring.md @@ -1,6 +1,4 @@ -A [`docstring`](https://docs.python.org/3/glossary.html#term-docstring) is a string with triple quotes that often used in file, classes, functions, etc. A docstring usually has clear explanation (such as what the function do, purposes of the function, and other details of the function), parameter(s) and a return type. - -Here's an example of a docstring: +A [`docstring`](https://docs.python.org/3/glossary.html#term-docstring) is a string with triple quotes that often used in file, classes, functions, etc. A docstring should have a clear explanation of exactly what the function does. You can also include descriptions of the function's parameter(s) and its return type, as shown below. ```py def greet(name, age) -> str: """ |