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: [FC-0074] replace warning text with event_warning annotation #431

Merged
merged 1 commit into from
Dec 12, 2024

Conversation

mariajgrimaldi
Copy link
Member

Description

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.

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

This PR depends on openedx/code-annotations#136

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.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 11, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 11, 2024

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 @openedx/hooks-extension-framework. 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:

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.

@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review December 11, 2024 12:06
@mariajgrimaldi mariajgrimaldi requested a review from a team as a code owner December 11, 2024 12:06
@mariajgrimaldi mariajgrimaldi changed the title docs: replace warning text with event_warning annotation docs: [FC-0074] replace warning text with event_warning annotation Dec 11, 2024
@mariajgrimaldi mariajgrimaldi added the FC Relates to an Axim Funded Contribution project label Dec 11, 2024
Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

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

@mariajgrimaldi mariajgrimaldi merged commit d6baea0 into main Dec 12, 2024
8 checks passed
@mariajgrimaldi mariajgrimaldi deleted the MJG/event-warning branch December 12, 2024 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants