docs: fix external groups functions docs #748
Merged
+2
−16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects the documentation for two external (SSO) group management functions by removing the members field from their return value specifications. The functions load_all_groups() and load_all_groups_for_members() return only group metadata (id and display name), not member details. Member information is only returned by the separate load_all_group_members() function.
Changes:
- Removed incorrect
membersfield documentation fromload_all_groups()return value - Removed incorrect
membersfield documentation fromload_all_groups_for_members()return value
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dorsha
changed the title
Coverage reportThe coverage rate went from None of the new lines are part of the tested code. Therefore, there is no coverage data about them. |
dorsha
changed the title
aviadl
approved these changes
Jan 24, 2026
dorsha
added a commit
that referenced
this pull request
Jan 25, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix external groups functions docs