diff --git a/ci/release/template/man/d2.1 b/ci/release/template/man/d2.1 index 7eb318f62..c71b96bec 100644 --- a/ci/release/template/man/d2.1 +++ b/ci/release/template/man/d2.1 @@ -113,7 +113,7 @@ Print debug logs. In watch mode, images used in icons are cached for subsequent compilations. This should be disabled if images might change .Ns . .It Fl -timeout Ar 120 -The number of seconds before d2 will timeout. +The maximum number of seconds that D2 runs for before timing out and exiting. When rendering a large diagram, it is recommended to increase this value. .Ns . .It Fl h , -help Print usage information and exit. diff --git a/d2cli/main.go b/d2cli/main.go index 4ce34764c..5fcf94c5d 100644 --- a/d2cli/main.go +++ b/d2cli/main.go @@ -89,7 +89,7 @@ func Run(ctx context.Context, ms *xmain.State) (err error) { if err != nil { return err } - timeoutFlag, err := ms.Opts.Int64("D2_TIMEOUT", "timeout", "", 120, "the number of seconds before d2 will timeout") + timeoutFlag, err := ms.Opts.Int64("D2_TIMEOUT", "timeout", "", 120, "the maximum number of seconds that D2 runs for before timing out and exiting. When rendering a large diagram, it is recommended to increase this value") if err != nil { return err }