From f0e281a6d0869cbc25030684de02d005c4edba51 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rory=20O=E2=80=99Kane?= <rory@roryokane.com>
Date: Mon, 4 May 2020 13:08:57 -0400
Subject: [PATCH] docs(api): mark the `.defaults` alias as deprecated more
 clearly (#1643)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

`.demand` and `.reset` have this “[DEPRECATED]” tag in their titles, so `.defaults` should too for consistency.
---
 docs/api.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/api.md b/docs/api.md
index 9fecb99ac..a4e2be2a0 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -427,11 +427,11 @@ flag occurrences rather than `true` or `false`. Default value is thus `0`.
 
 <a name="default"></a>.default(key, value, [description])
 ---------------------------------------------------------
-.defaults(key, value, [description])
+.defaults(key, value, [description]) [DEPRECATED]
 ------------------------------------
 
-**Note:** The `.defaults()` alias is deprecated. It will be
-removed in the next major version.
+**Note:** The `.defaults()` alias is deprecated. It will be removed in the next
+major version. Use `.default()` instead.
 
 Set `argv[key]` to `value` if no option was specified in `process.argv`.