clarify the friends.hops method and set max to 0
This commit is contained in:
parent
8a37bfcb61
commit
4281f40523
|
@ -236,7 +236,7 @@ impl Sbot {
|
||||||
/// ```
|
/// ```
|
||||||
pub async fn get_follows(&mut self) -> Result<Vec<String>, GolgiError> {
|
pub async fn get_follows(&mut self) -> Result<Vec<String>, GolgiError> {
|
||||||
self.friends_hops(FriendsHops {
|
self.friends_hops(FriendsHops {
|
||||||
max: 1,
|
max: 0,
|
||||||
start: None,
|
start: None,
|
||||||
reverse: Some(false),
|
reverse: Some(false),
|
||||||
})
|
})
|
||||||
|
@ -272,7 +272,7 @@ impl Sbot {
|
||||||
/// ```
|
/// ```
|
||||||
async fn _get_followers(&mut self) -> Result<Vec<String>, GolgiError> {
|
async fn _get_followers(&mut self) -> Result<Vec<String>, GolgiError> {
|
||||||
self.friends_hops(FriendsHops {
|
self.friends_hops(FriendsHops {
|
||||||
max: 1,
|
max: 0,
|
||||||
start: None,
|
start: None,
|
||||||
reverse: Some(true),
|
reverse: Some(true),
|
||||||
})
|
})
|
||||||
|
@ -283,8 +283,18 @@ impl Sbot {
|
||||||
///
|
///
|
||||||
/// A `RelationshipQuery` `struct` must be defined and passed into this method.
|
/// A `RelationshipQuery` `struct` must be defined and passed into this method.
|
||||||
///
|
///
|
||||||
/// When opts.reverse = True, it should return peers who are following you
|
/// Hops = 0 returns a list of peers followed by the local identity.
|
||||||
/// (but this is not currently working).
|
/// Those peers may or may not be mutual follows (ie. friends).
|
||||||
|
///
|
||||||
|
/// Hops = 1 includes the peers followed by the peers we follow.
|
||||||
|
/// For example, if the local identity follows Aiko and Aiko follows
|
||||||
|
/// Bridgette and Chris, hops = 1 will return a list including the public
|
||||||
|
/// keys for Aiko, Bridgette and Chris (even though Bridgette and Chris
|
||||||
|
/// are not followed by the local identity).
|
||||||
|
///
|
||||||
|
/// When reverse = True, hops = 0 should return a list of peers who
|
||||||
|
/// follow the local identity, ie. followers (but this is not currently
|
||||||
|
/// implemented in go-sbot).
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
///
|
///
|
||||||
|
|
Loading…
Reference in New Issue