feat: Add a config for openedx-events annotations#98
Merged
Conversation
bmtcril
force-pushed
the
bmtcril/add_openedx_events
branch
19 times, most recently
from
d4cf0e7 to
1718a0c
Compare
bmtcril
force-pushed
the
bmtcril/add_openedx_events
branch
5 times, most recently
from
3185ec4 to
7bd4dca
Compare
bmtcril
force-pushed
the
bmtcril/add_openedx_events
branch
from
7bd4dca to
541f1f7
Compare
11 tasks
timmc-edx
approved these changes
Feb 20, 2024
Contributor
timmc-edx
left a comment
timmc-edx
left a comment
There was a problem hiding this comment.
My review shouldn't be considered authoritative as I'm not a maintainer and I'm not familiar with this repo, but -- I did review the fields/annotations for completeness and consistency.
Contributor
Author
|
@mariajgrimaldi thanks, the docs said that first argument was supposed to be a separator so I thought it would... do that. :) All set now. |
mariajgrimaldi
approved these changes
Feb 26, 2024
Member
There was a problem hiding this comment.
@timmc-edx: this implementation is similar to the featuretoggles one
with implementation-specific changes to generate events docs instead. I understand you're not the maintainer of the repo, so could we include someone familiar with the code? Because of the similarity with the other extensions, I don't think it'd be difficult to review.
Contributor
|
I've attempted to ping the owning team within 2U, but haven't heard back yet. I think if another week goes by without hearing from them, we should just merge this. |
Contributor
|
@bmtcril I think we're good to merge this. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description: Adding code and config to find and document annotations used in the openedx-events repository. When run in openedx-events (see openedx/openedx-events#318) the generated documentation looks like this: