summaryrefslogtreecommitdiffstats
path: root/examples/docstring.py
diff options
context:
space:
mode:
Diffstat (limited to 'examples/docstring.py')
-rw-r--r--examples/docstring.py26
1 files changed, 26 insertions, 0 deletions
diff --git a/examples/docstring.py b/examples/docstring.py
new file mode 100644
index 0000000..ab185b6
--- /dev/null
+++ b/examples/docstring.py
@@ -0,0 +1,26 @@
+"""Documentation for this module.
+
+More details.
+"""
+
+def func():
+ """Documentation for a function.
+
+ More details.
+ """
+ pass
+
+class PyClass:
+ """Documentation for a class.
+
+ More details.
+ """
+
+ def __init__(self):
+ """The constructor."""
+ self._memVar = 0;
+
+ def PyMethod(self):
+ """Documentation for a method."""
+ pass
+