Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation for updateUserMemberships function, closes #1124 #1132

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

alhridoy
Copy link
Contributor

@alhridoy alhridoy commented Oct 6, 2023

This pull request addresses issue #1124. The documentation for the updateUserMemberships function was incorrect, suggesting the use of admins as a parameter, while the correct parameters are users and newMemberType.

The comments in the code have been updated to reflect the correct usage of the function. This should ensure that the automatically generated documentation is now correct.

@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (33aba89) 100.00% compared to head (1b2490e) 100.00%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1132   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          177       177           
  Lines         3245      3245           
  Branches       550       550           
=========================================
  Hits          3245      3245           
Files Coverage Δ
...s-rest-portal/src/groups/update-user-membership.ts 100.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@gavinr-maps gavinr-maps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This updates the sample code to reflect the actual option on type input https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-portal/IUpdateGroupUsersOptions#newMemberType - looks good!

@gavinr-maps gavinr-maps merged commit 92ec68c into Esri:main Oct 10, 2023
5 checks passed
@gavinr-maps gavinr-maps removed their assignment Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants