Skip to content

Commit

Permalink
default doc string wrapping to 160 chars
Browse files Browse the repository at this point in the history
See #44 (comment).
Presently, in the pebble repository, there are violations of docstrings being
limited to 80 chars. This change updates the default to 160 chars to prevent CI
from failing.
  • Loading branch information
jayshrivastava committed May 5, 2023
1 parent e09a10b commit 4067d8f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import (

var (
// TODO: wrap doc strings for imports and floating comments.
wrapdoc = flag.Int("wrapdoc", 80, "column at which to wrap doc strings for functions, variables, constants, and types. ignores multiline comments denoted by /*")
wrapdoc = flag.Int("wrapdoc", 160, "column at which to wrap doc strings for functions, variables, constants, and types. ignores multiline comments denoted by /*")
wrap = flag.Int("wrap", 100, "column to wrap at")
tab = flag.Int("tab", 2, "tab width for column calculations")
overwrite = flag.Bool("w", false, "overwrite modified files")
Expand Down
1 change: 1 addition & 0 deletions main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ func TestCheckPath(t *testing.T) {
*printDiff = false
*tab = 8
*groupImports = false
*wrapdoc = 80
files, err := filepath.Glob("testdata/*.in.go")
if err != nil {
t.Fatal(err)
Expand Down

0 comments on commit 4067d8f

Please sign in to comment.