Skip to content

Deprecate Wait.md #1170

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

Merged
merged 2 commits into from
Dec 5, 2019
Merged

Deprecate Wait.md #1170

merged 2 commits into from
Dec 5, 2019

Conversation

AnotherButler
Copy link
Contributor

Replace content with deprecation warning.

Replace content with deprecation warning.
Copy link
Member

@bulislaw bulislaw left a comment

Choose a reason for hiding this comment

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

Not all calls were deprecated.

@AnotherButler
Copy link
Contributor Author

So should we keep the body content and add a note that says "Warning: The wait and wait_ms calls of this API have been deprecated. In their place, please use explicit sleep functions and wait_us."?

@AnotherButler
Copy link
Contributor Author

ping @bulislaw

Copy link
Member

@bulislaw bulislaw left a comment

Choose a reason for hiding this comment

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

I think we should basically say the same as the deprecation notice (maybe with links): MBED_DEPRECATED_SINCE("mbed-os-5.14", "'wait' is deprecated in favor of explicit sleep functions. To sleep, 'wait' should be replaced by " "'ThisThread::sleep_for' (C++) or 'thread_sleep_for' (C). If you wish to wait (without sleeping), call " "'wait_us'. 'wait_us' is safe to call from ISR context.")

I'll update the examples not to use deprecated calls.

Update warning to match code.
@AnotherButler
Copy link
Contributor Author

@bulislaw Does this resolve your concerns?

@AnotherButler AnotherButler merged commit 834b570 into development Dec 5, 2019
@AnotherButler AnotherButler deleted the AnotherButler-patch-2 branch December 5, 2019 18:19
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