Closed mariajgrimaldi closed 3 months ago
Thanks for the pull request, @mariajgrimaldi! 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:
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.
Hi @Ian2012 @felipemontoya! Here's a PR for better docs on the filters that are available. I'll also update the classes' docstrings so they have more meaningful content. But in the meantime, what do you think about the format? Is it enough info? What else should we add? Thanks!
Since I'm only changing documentation, I'll be merging as is even with the coverage failures.
@mariajgrimaldi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.
Description
This PR adds the necessary configuration for automatic docs generation based on Open edX Filters classes, you can see the docs generated here: https://docsopenedxorg--173.org.readthedocs.build/projects/openedx-filters/en/173/