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

docs: Remove coroutine/DPP_CORO experimental warnings #1221

Merged
merged 12 commits into from
Sep 29, 2024

Conversation

DJOetzi
Copy link
Contributor

@DJOetzi DJOetzi commented Aug 12, 2024

Removed notices of coroutines being an experimental feature.

Documentation change checklist

  • My documentation changes follow the docs style guide and any code examples follow the coding style guide.
  • I tested that my change works before raising the PR (via running doxygen, and testing examples).
  • I have not moved any existing pages or changed any existing URLs without strong justification as to why.
  • I have not generated content using AI or a desktop utility such as grammarly.

@CLAassistant
Copy link

CLAassistant commented Aug 12, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

netlify bot commented Aug 12, 2024

Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit 018c3d3
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/66f92226046e390008fb64b5
😎 Deploy Preview https://deploy-preview-1221--dpp-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added documentation Improvements or additions to documentation build Issue or Pull Request related to the build process labels Aug 12, 2024
@braindigitalis braindigitalis changed the title Remove coroutine/DPP_CORO experimental warnings docs: Remove coroutine/DPP_CORO experimental warnings Aug 12, 2024
Copy link
Contributor

@Jaskowicz1 Jaskowicz1 left a comment

Choose a reason for hiding this comment

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

You're missing

* @warning - This feature is EXPERIMENTAL. The API may change at any time and there may be bugs.

* @warning - This feature is EXPERIMENTAL. The API may change at any time and there may be bugs. Please report any to <a href="https://github.com/brainboxdotcc/DPP/issues">GitHub issues</a> or to the <a href="https://discord.gg/dpp">D++ Discord server</a>.

message("-- ${Yellow}Enabled experimental coroutine feature${ColourReset}")
(just remove the word "experimental" here, keep the message()).

* @warning - This feature is EXPERIMENTAL. The API may change at any time and there may be bugs.

* @warning - This feature is EXPERIMENTAL. The API may change at any time and there may be bugs.

docpages/example_programs/using_coroutines.md Outdated Show resolved Hide resolved
@Jaskowicz1
Copy link
Contributor

Any update on this?

@DJOetzi
Copy link
Contributor Author

DJOetzi commented Sep 4, 2024

You're missing

* @warning - This feature is EXPERIMENTAL. The API may change at any time and there may be bugs.

* @warning - This feature is EXPERIMENTAL. The API may change at any time and there may be bugs. Please report any to <a href="https://github.com/brainboxdotcc/DPP/issues">GitHub issues</a> or to the <a href="https://discord.gg/dpp">D++ Discord server</a>.

message("-- ${Yellow}Enabled experimental coroutine feature${ColourReset}")

(just remove the word "experimental" here, keep the message()).

* @warning - This feature is EXPERIMENTAL. The API may change at any time and there may be bugs.

* @warning - This feature is EXPERIMENTAL. The API may change at any time and there may be bugs.

should I just remove these comments altogether?

@Jaskowicz1 Jaskowicz1 removed the request for review from Mishura4 September 29, 2024 10:22
@Jaskowicz1 Jaskowicz1 merged commit d43239f into brainboxdotcc:dev Sep 29, 2024
50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issue or Pull Request related to the build process documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants