Skip to content

Commit

Permalink
Update docstring for warp_string and increase max
Browse files Browse the repository at this point in the history
42 is a little too short, especially when defaults are used
  • Loading branch information
Sbozzolo committed Aug 16, 2024
1 parent d4b3b4b commit ab86893
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/Utils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ function seconds_to_prettystr(seconds::Real)
end

"""
warp_string(str::AbstractString)
warp_string(str::AbstractString; max_width = 70)
Return a string where each line is at most `max_width` characters or less
or at most one word.
Expand Down Expand Up @@ -234,7 +234,7 @@ julia> warp_string("\\n space \\n space", max_width = 4)
"space\\nspace"
```
"""
function warp_string(str::AbstractString; max_width = 42)
function warp_string(str::AbstractString; max_width = 70)
return_str = ""
current_width = 0
for word in split(str, isspace)
Expand Down

0 comments on commit ab86893

Please sign in to comment.