Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,6 @@ this code
This module docstring should be dedented."""


def launch_rocket():
"""Launch
the
rocket. Go colonize space."""


def factorial(x):
'''

Expand All @@ -141,7 +135,7 @@ this code
function"""
print_factorial(5)
if factorial(10):
launch_rocket()
print_factorial(22)


gets formatted into this
Expand All @@ -153,14 +147,6 @@ gets formatted into this
This module docstring should be dedented.
"""


def launch_rocket():
"""Launch the rocket.

Go colonize space.
"""


def factorial(x):
"""Return x factorial.

Expand All @@ -179,7 +165,7 @@ gets formatted into this
"""Main function."""
print_factorial(5)
if factorial(10):
launch_rocket()
print_factorial(22)

Marketing
=========
Expand Down
4 changes: 3 additions & 1 deletion src/docformatter/syntax.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
"""

HEURISTIC_MIN_LIST_ASPECT_RATIO = 0.4
"""The minimum aspect ratio to consider a list."""


def description_to_list(
Expand Down Expand Up @@ -649,7 +650,8 @@ def is_some_sort_of_list(
"""
split_lines = text.rstrip().splitlines()

# TODO: Find a better way of doing this.
# TODO: Find a better way of doing this. Conversely, create a logger and log
# potential lists for the user to decide if they are lists or not.
# Very large number of lines but short columns probably means a list of
# items.
if (
Expand Down
Loading