Skip to content

Commit d3f60ff

Browse files
authored
Merge pull request #77 from braboj/codex/add-comment-header-for-docstring-purpose
Improve docstring header
2 parents 64f3c2e + 2e9cc0c commit d3f60ff

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

examples/09_docstrings/docstring_function.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# Docstring for a Function
2+
# --------------------------------------------------------------------------------
3+
# Documenting a function with a docstring explains what the function does,
4+
# clarifies its expected arguments and return value, and allows automated
5+
# tools to generate user-friendly documentation.
6+
17
def myfunction(a, b, c):
28
"""This is junior docstring for myfunction
39

0 commit comments

Comments
 (0)