feat: add support for optional event warning for in-line annotation

[mariajgrimaldi]

Description

Add warning for openedx-events annotations so developers can include relevant information about the current event. As for now, these warnings have been used to indicate that the event at the time of implementation doesn't have for the event bus.

Testing Instructions

1. Create a venv
2. Install this version of openedx-events which uses .. event_warning instead of a Warning: label.
3. Generate docs for openedx-events by running: make docs

Here's the expected output:

[openedx-webhooks]

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To 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:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If 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 @bmtcril. Tag them in a comment and let them know that your changes are ready for review.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[sarina]

Should the fields for events be documented somewhere? I see https://edx-toggles.readthedocs.io/en/latest/how_to/documenting_new_feature_toggles.html mentioned at L9 but it doesn't contain anything about events

[mariajgrimaldi]

I think the L9 was a copy-paste error, perhaps. And yes, this should definitely be documented somewhere. I going to find them a place in the openedx-events' docs. Thanks!

[bmtcril]

This should be good to go if you update that link 👍

[mariajgrimaldi]

Here's the PR with the updated docs: openedx/openedx-events#432

[mariajgrimaldi]

Done! Thank you both

I'll update code-annotations in openedx-events once this gets merged.

[bmtcril]

If you bump the version I can merge and release!