| Index: doxypypy/doxypypy/test/sample_sections.py
|
| diff --git a/doxypypy/doxypypy/test/sample_sections.py b/doxypypy/doxypypy/test/sample_sections.py
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..87796b415e9d77a25585e9b3e410a46094256f77
|
| --- /dev/null
|
| +++ b/doxypypy/doxypypy/test/sample_sections.py
|
| @@ -0,0 +1,40 @@
|
| +#!/usr/bin/env python
|
| +# encoding: utf-8
|
| +"""
|
| +Sample documentation the arbitrary section handling.
|
| +
|
| +Related to issue #7 [1].
|
| +
|
| +[1]: https://github.com/Feneric/doxypypy/issues/7
|
| +"""
|
| +
|
| +
|
| +def function(arg1, arg2):
|
| + """A simple function of two arguments.
|
| +
|
| + This function takes two arguments, but does absolutely nothing with them.
|
| + However, it sends out a friendly greeting to the world.
|
| +
|
| + Args:
|
| + arg1: The first argument
|
| + arg2: The second argument
|
| +
|
| + Returns:
|
| + A string stating "Hello World"
|
| +
|
| + Examples:
|
| + >>> function(1, 2)
|
| + "Hello World"
|
| + >>> function('a', 'b')
|
| + "Hello World"
|
| +
|
| + Intent:
|
| + The intent is to demonstrate sections like this one within docstrings.
|
| + How they behave with multiple lines.
|
| +
|
| + And how they behave with multiple paragraphs.
|
| + That contain multiple lines.
|
| +
|
| + Paragraphs stading by themselves without indention, should be left alone.
|
| + """
|
| + return "Hello World"
|
|
|