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 User.callFunction JSDoc to match the v11+ API #5768

Merged
merged 1 commit into from
Jun 2, 2023

Conversation

nlarew
Copy link
Contributor

@nlarew nlarew commented Apr 25, 2023

What, How & Why?

The JSDoc for User.callFunction() has an incorrect example that still uses the pre-v11 function signature. This updates the example & tweaks the JSDoc descriptions.

☑️ ToDos

  • 📝 Changelog entry
  • 📝 Compatibility label is updated or copied from previous entry
  • 📝 Update COMPATIBILITY.md
  • 🚦 Tests
  • 🔀 Executed flexible sync tests locally if modifying flexible sync
  • 📦 Updated internal package version in consuming package.jsons (if updating internal packages)
  • 📱 Check the React Native/other sample apps work if necessary
  • 📝 Public documentation PR created or is not necessary
  • 💥 Breaking label has been applied or is not necessary

If this PR adds or changes public API's:

  • typescript definitions file is updated
  • jsdoc files updated

@cla-bot cla-bot bot added the cla: yes label Apr 25, 2023
Copy link
Member

@elle-j elle-j left a comment

Choose a reason for hiding this comment

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

Thanks Nick!

@kneth kneth merged commit ca790be into realm:main Jun 2, 2023
16 of 24 checks passed
papafe added a commit that referenced this pull request Jun 7, 2023
* main:
  Fix User.callFunction JSDoc to match the v11+ API (#5768)
  Add Flexible Sync subscribe/unsubscribe APIs (#5772)
  Fix warning for deprecated namespace setting method in Android (#5862)
  Update install-test-react-native.yml (#5848)
  Update package-unit-tests.yml to add ccache and ninja (#5837)
  Enable cleartext traffic in android test app to make tests work in release builds

# Conflicts:
#	CHANGELOG.md
papafe added a commit that referenced this pull request Jun 7, 2023
* fp/update-core-13.13:
  Corrected changelog
  Updated changelog
  Fix User.callFunction JSDoc to match the v11+ API (#5768)
  Add Flexible Sync subscribe/unsubscribe APIs (#5772)
  Fix warning for deprecated namespace setting method in Android (#5862)
  Update install-test-react-native.yml (#5848)
  Update package-unit-tests.yml to add ccache and ninja (#5837)
  Enable cleartext traffic in android test app to make tests work in release builds
  Removed unused
  Updated changelog

# Conflicts:
#	packages/realm/bindgen/vendor/realm-core
#	packages/realm/src/index.ts
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants