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

Clarify HapticEffect is not out on HapticService deprecation msg #1023

Merged
merged 3 commits into from
Feb 12, 2025

Conversation

dgxo
Copy link
Contributor

@dgxo dgxo commented Feb 12, 2025

Changes

Change deprecation notice in HapticService to clarify that HapticEffect is not yet available, and set an alias so Class. is not visible but it will still link to HapticEffect when it is added.

Report: https://devforum.roblox.com/t/feedback-on-hapticservice/3466028/2

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

@dgxo dgxo requested a review from a team as a code owner February 12, 2025 20:58
@github-actions github-actions bot added the engine reference Changes the Engine API Reference documentation label Feb 12, 2025
@dgxo
Copy link
Contributor Author

dgxo commented Feb 12, 2025

Perhaps the text inside the deprecation notice could be moved into the description and reworded, to let developers know that a replacement is coming?

@sammygrey
Copy link
Contributor

Change not needed:
The HapticService class is still deprecated regardless of the current implementation status of HapticEffect. HapticEffect is the intended future replacement for HapticService and even though it isn't yet implemented or has documentation, It's a nice feature for users looking at the HapticService page.

@dgxo dgxo changed the title Remove deprecation notice in HapticService Clarify that HapticEffect is not yet released on HapticService deprecation Feb 12, 2025
@dgxo dgxo changed the title Clarify that HapticEffect is not yet released on HapticService deprecation Clarify HapticEffect is not out on HapticService deprecation msg Feb 12, 2025
@dgxo
Copy link
Contributor Author

dgxo commented Feb 12, 2025

Change not needed: The HapticService class is still deprecated regardless of the current implementation status of HapticEffect. HapticEffect is the intended future replacement for HapticService and even though it isn't yet implemented or has documentation, It's a nice feature for users looking at the HapticService page.

Changed the PR to make the deprecation message make more sense for devs

@dgxo
Copy link
Contributor Author

dgxo commented Feb 12, 2025

right whats prettier done here then

@IgnisRBX IgnisRBX merged commit 6352137 into Roblox:main Feb 12, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engine reference Changes the Engine API Reference documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants