From 3fb094a9b8c320fc10e537a9bb5fab34807f4e52 Mon Sep 17 00:00:00 2001 From: Maximilian Krambach Date: Fri, 17 Aug 2018 17:14:51 +0200 Subject: [PATCH] js: small documentation fix -- --- lang/js/src/Key.js | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/lang/js/src/Key.js b/lang/js/src/Key.js index 5d0c8160..ea6fd883 100644 --- a/lang/js/src/Key.js +++ b/lang/js/src/Key.js @@ -179,12 +179,13 @@ class GPGME_Key { }; /** - * Find out if the Key includes a secret part. Note that this is a - * rather nonperformant operation. - * If you want this inforrmation about more than a few Keys, it may be - * advisable to run {@link Keyring.getKeys} instead. - * @returns {Promise} True if a secret/private Key - * is available in the gnupg Keyring + * Find out if the Key is part of a Key pair including public and + * private key(s). If you want this information about more than a few + * Keys in synchronous mode, it may be advisable to run + * {@link Keyring.getKeys} instead, as it performs faster in bulk + * querying this state. + * @returns {Promise} True if a private Key is + * available in the gnupg Keyring. * @async */ this.getGnupgSecretState = function (){