docformatter_cli_and_api_pep257_docstring_formatting.py

1# While docformatter is primarily used as a command-line tool, 
2# the official documentation demonstrates its usage via CLI.
3# To format a file in-place, you would run:
4
5docformatter --in-place example.py
6
7# To use it programmatically within Python (as used in its own test suite/API):
8
9import docformatter
10
11unformatted_code = '''
12def hello_world():
13    """
14    This is a multi-line docstring
15    that is not formatted correctly.
16    """
17    pass
18'''
19
20formatted_code = docformatter.format_code(unformatted_code)
21print(formatted_code)