-
Notifications
You must be signed in to change notification settings - Fork 17
Fix typos and improve documentation clarity #167
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
base: master
Are you sure you want to change the base?
Conversation
|
Thanks for the pull request, @CodeWithEmad! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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. DetailsWhere 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. |
|
Hi @openedx/wg-maintainers-forums! Would someone be able to review / merge this? |
|
Hi @openedx/wg-maintainers-forums! Any chance we can get this looked at? It's been stalled a bit. |
sarina
left a comment
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.
This PR needs a rebase.
README.rst
Outdated
| The only prerequisite for installation is a working Open edX platform with `Tutor <https://docs.tutor.edly.io/>`__, on the Sumac release (v19+) or the `main branch <https://docs.tutor.edly.io/tutorials/main.html>`__. Enable the forum by running:: | ||
| The only prerequisite for installation is a working Open edX platform with `Tutor <https://docs.tutor.edly.io/>`__, on the Sumac release (v19+) or the `main branch <https://docs.tutor.edly.io/tutorials/main.html>`__. Enable the forum by running: | ||
|
|
||
| .. code-block:: bash |
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 disagree with this change, because rendering this as a bash codeblock erroneously highlights bash keywords. I think this README is better with generic codeblocks for the shell commands. The python and yaml blocks are a value-add.
forum/backends/backend.py
Outdated
|
|
||
| @classmethod | ||
| def threads_presentor( | ||
| def threads_presenter( |
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.
Is this going to have an effect outside of this app? I don't think correcting typos that exist as part of method or class names is worth potential downstream breakages.
|
Hi @CodeWithEmad - just checking in to see if you are still working on this? |
99e9e14 to
ac81c19
Compare
|
It's ready for review |
- typos fixed - syntax highlighting added
ac81c19 to
253ab22
Compare
|
Looks like tests are failing @CodeWithEmad |
Corrected various typos in the codebase and enhanced documentation with syntax highlighting for better readability.
a rewrite of #156
@taimoor-ahmed-1 @Ali-Salman29