Skip to content

Commit 6f7c49f

Browse files
Lingling PengLingling Peng
authored andcommitted
fix docstring to match synapse documentation
1 parent f7e1a9f commit 6f7c49f

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

synapseclient/models/team.py

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,19 @@ def fill_from_dict(
6161
class TeamMembershipStatus:
6262
"""
6363
Contains information about a user's membership status in a Team.
64-
In practice the constructor is not called directly by the client.
64+
Represents a [Synapse TeamMembershipStatus](<https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/TeamMembershipStatus.html>).
65+
User definable fields are:
6566
6667
Attributes:
67-
team_id: The synapse ID of the team
68-
user_id: The synapse ID of the user
69-
is_member: Whether the user is a member of the team
70-
has_open_invitation: Whether the user has an open invitation to join the team
71-
has_open_request: Whether the user has an open request to join the team
72-
can_join: Whether the user can join the team
73-
membership_approval_required: Whether membership approval is required for the team
74-
has_unmet_access_requirement: Whether the user has unmet access requirements
75-
can_send_email: Whether the user can send email to the team
68+
team_id: The id of the Team.
69+
user_id: The principal id of the user.
70+
is_member: true if and only if the user is a member of the team
71+
has_open_invitation: true if and only if the user has an open invitation to join the team
72+
has_open_request: true if and only if the user has an open request to join the team
73+
can_join: true if and only if the user requesting this status information can join the user to the team
74+
membership_approval_required: true if and only if team admin approval is required for the user to join the team
75+
has_unmet_access_requirement: true if and only if there is at least one unmet access requirement for the user on the team
76+
can_send_email: true if and only if the user can send an email to the team
7677
"""
7778

7879
team_id: Optional[str] = None

0 commit comments

Comments
 (0)