-
Notifications
You must be signed in to change notification settings - Fork 17
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] add details for illustrating how filters work #231
Conversation
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. |
8a29483
to
65af164
Compare
I think the filter numbers on this diagram (function 0, function n-1) don't match the revised way we numbered the filter steps in another PR |
b10058d
to
64f6c5c
Compare
65af164
to
f159f3e
Compare
I'm sorry, this still needs work so I'm turning it into draft. Good news! It didn't take me that long to make it re-ready. |
|
||
#. This method retrieves the configuration from ``OPEN_EDX_FILTERS_CONFIG``, which defines a list of N functions :math:`f_1, f_2, \ldots, f_{n}` that will be executed. | ||
|
||
#. Then it executes each function in the pipeline sequentially, starting with :math:`f_1`, which processes the input arguments ``kwargs`` and applies the developer's operations, returning potentially modified arguments ``kwargs_1``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the diagram I'm using kwargs because that's how filters are called, by using keyword arguments. Now, I'm not sure if using kwargs makes the explanation more cumbersome to read.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think Python developers should understand kwargs
, no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, of course. I was referring to how good (fluent?) it read, but it should be fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the diagram is a bit misleading, because step2 raises an exception but the diagram indicates that step N still runs. I think I would just omit the FilterException from the diagram (just have the line return kwargs_2
) to be the happy path, and then step 8 in the workflow will explain how f_2
could return an exception.
@sarina: I'd prefer we represented both situations, though. I'm going to add both versions to see how well they read or if they're too much. EDIT: I think your suggestion is more cleaner than mine, so I'll go with that. |
bbbbfe9
to
f18c31f
Compare
f18c31f
to
1218e42
Compare
1218e42
to
56929d0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The information in the change is correct. The graph look nice and it explains every step of the process. I think the language flows naturally and the result is easy to read. Overall great work.
Description
This PR: