From 17e705428ddf80c7a7f31fe5430d966cf08a37d6 Mon Sep 17 00:00:00 2001 From: Amiti Uttarwar Date: Fri, 10 Mar 2023 18:25:59 -0800 Subject: [PATCH] doc: clarify new_only param for Select function Co-authored-by: Martin Zumsande --- src/addrman.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/addrman.h b/src/addrman.h index c8e31fe283..6284b80a52 100644 --- a/src/addrman.h +++ b/src/addrman.h @@ -146,7 +146,9 @@ public: /** * Choose an address to connect to. * - * @param[in] new_only Whether to only select addresses from the new table. + * @param[in] new_only Whether to only select addresses from the new table. Passing `true` returns + * an address from the new table or an empty pair. Passing `false` will return an + * address from either the new or tried table (it does not guarantee a tried entry). * @param[in] network Select only addresses of this network (nullopt = all) * @return CAddress The record for the selected peer. * seconds The last time we attempted to connect to that peer.