docs: [FC-0074] replace warning text with event_warning annotation#431
docs: [FC-0074] replace warning text with event_warning annotation#431mariajgrimaldi merged 1 commit intomainfrom
Conversation
Use `.. event_warning` annotation to indicate a critical characteristic of an event. As for now, these warnings have been used to warn users about missing event bus capabilities.
|
Thanks for the pull request, @mariajgrimaldi! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Description
Use
.. event_warningannotation to indicate a critical characteristic of an event. As for now, these warnings have been used to warn users about missing event bus capabilities.Testing Instructions
.. event_warninginstead of aWarning:label.make docsHere's the expected output:

This PR depends on openedx/code-annotations#136