From 1e3fc0a808938281ac29b381d9d57ae820df7549 Mon Sep 17 00:00:00 2001 From: miccal Date: Wed, 5 Oct 2016 13:12:16 +0800 Subject: [PATCH] Update caveats.md --- doc/cask_language_reference/stanzas/caveats.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/cask_language_reference/stanzas/caveats.md b/doc/cask_language_reference/stanzas/caveats.md index a6b58e7e75d..1f03ac180d3 100644 --- a/doc/cask_language_reference/stanzas/caveats.md +++ b/doc/cask_language_reference/stanzas/caveats.md @@ -1,6 +1,6 @@ # caveats -Sometimes there are particularities with the installation of a piece of software that cannot or should not be handled programatically by Homebrew-Cask. In those instances, `caveats` is the way to inform the user. Information in `caveats` is displayed when a cask is invoked with either `install` or `info`. +Sometimes there are particularities with the installation of a piece of software that cannot or should not be handled programmatically by Homebrew-Cask. In those instances, `caveats` is the way to inform the user. Information in `caveats` is displayed when a cask is invoked with either `install` or `info`. To avoid flooding users with too many messages (thus desensitising them to the important ones), `caveats` should be used sparingly and exclusively for installation-related matters. If you’re not sure a `caveat` you find pertinent is installation-related or not, ask a maintainer. As a general rule, if your case isn’t already covered in our comprehensive [`caveats Mini-DSL`](#caveats-mini-dsl), it’s unlikely to be accepted.