Skip to content

Improve docstring header #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
braboj merged 1 commit into from
Jun 11, 2025
Merged

Improve docstring header #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions examples/09_docstrings/docstring_function.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Docstring for a Function
# --------------------------------------------------------------------------------
# Documenting a function with a docstring explains what the function does,
# clarifies its expected arguments and return value, and allows automated
# tools to generate user-friendly documentation.

def myfunction(a, b, c):
"""This is junior docstring for myfunction

Expand Down