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

fix: set JSONRenderer as the DEFAULT_RENDERER_CLASSES #403

Merged
merged 2 commits into from
May 6, 2024

Conversation

CodeWithEmad
Copy link
Member

This will introduce a similar approach as edx-platform to set JSONRenderer as the DEFAULT_RENDERER_CLASSES. with this, we don't have Browsable APIs anymore. also, some code reformatting with black and RST cleanup in README.

See here for more context: overhangio/tutor-notes#35

@openedx-webhooks
Copy link

Thanks for the pull request, @CodeWithEmad! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 22, 2024
@CodeWithEmad CodeWithEmad force-pushed the fix/json-renderer branch 2 times, most recently from fadf249 to 1a4fb82 Compare April 22, 2024 15:26
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Apr 22, 2024
@kdmccormick kdmccormick self-assigned this Apr 22, 2024
@kdmccormick
Copy link
Member

Thanks for the PR @CodeWithEmad . I think the JSON change looks good. Let me see if there is a maintainer that'd want to review this before I merge it.

Regarding black, there is a cost associated with reformatting, in that it complicates git blame and makes it harder for folks with forks to rebase. So, my rule of thumb is that we should only reformat it if we also enforce the new style in CI so that we never need to apply the same reformatting again. Please remove the black commit from this PR, but feel free to introduce it in a new PR along with a black CI check if that interests you.

(the docs reformatting is good to stay -- the considerations about git and forks do not apply so much :)

@CodeWithEmad
Copy link
Member Author

CodeWithEmad commented Apr 23, 2024

Sure @kdmccormick. Thanks for the explanation. I always make sure to leave any code base cleaner than how I found it. :)

@e0d
Copy link

e0d commented Apr 25, 2024

@CodeWithEmad I've run the test. I've also added you to the triage team as you are covered under an entity CLA. This means that tests should run automatically for you in the future. Let me know if that doesn't happen.

@CodeWithEmad
Copy link
Member Author

Thanks @e0d

@CodeWithEmad
Copy link
Member Author

Let me know if that doesn't happen.

I pushed new changes but: "This workflow requires approval from a maintainer."
@e0d

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

Looks good!

Let's see if re-running those migration checks fixes them...

@mphilbrick211
Copy link

@CodeWithEmad the tests have been re-run - looks like some checks are still failing.

@mphilbrick211 mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Apr 30, 2024
- RST header definition
- code-block for better readability
- removed $ from commands for simpler copying
@CodeWithEmad
Copy link
Member Author

That's super odd. I've added 1 DRF config and the tests are failing on installing the dependencies! I'll look into it.

@CodeWithEmad
Copy link
Member Author

@mphilbrick211 All checks have passed.

@kdmccormick kdmccormick merged commit 8d5a272 into openedx:master May 6, 2024
12 checks passed
@openedx-webhooks
Copy link

@CodeWithEmad 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@kdmccormick
Copy link
Member

Thanks @CodeWithEmad !

@CodeWithEmad CodeWithEmad deleted the fix/json-renderer branch June 7, 2024 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants