[tor-commits] [stem/master] Clarify what get_server_descriptors provides

[atagar at torproject.org]

commit 27b2cbd7204720520667e9683dc45f2605e5de40
Author: Damian Johnson <atagar at torproject.org>
Date:   Fri Apr 20 09:49:05 2018 -0700

    Clarify what get_server_descriptors provides
    
    The 'all descriptors in the present consensus' description in our docs was
    incorrect. This provides all descriptors known by the relay we're downloading
    from, but that doesn't necessarily match what's in the consensus...
    
      https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt#n3840
    
    Pointed out by cypherpunks on...
    
      https://trac.torproject.org/projects/tor/ticket/25866
---
 stem/descriptor/remote.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/stem/descriptor/remote.py b/stem/descriptor/remote.py
index 8e5b759d..89019c2d 100644
--- a/stem/descriptor/remote.py
+++ b/stem/descriptor/remote.py
@@ -644,8 +644,8 @@ class DescriptorDownloader(object):
   def get_server_descriptors(self, fingerprints = None, **query_args):
     """
     Provides the server descriptors with the given fingerprints. If no
-    fingerprints are provided then this returns all descriptors in the present
-    consensus.
+    fingerprints are provided then this returns all descriptors known
+    by the relay.
 
     :param str,list fingerprints: fingerprint or list of fingerprints to be
       retrieved, gets all descriptors if **None**