fix documentation workflow and added script.py for typedoc MPX compatible #1314
Conversation
…rated files MPX compatible
Our Pull Request Approval ProcessWe have these basic policies to make the approval process smoother for our volunteer team. Testing Your CodePlease make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:
The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing. ReviewersWhen your PR has been assigned reviewers contact them to get your code reviewed and approved via:
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
.github/workflows/script.py
Outdated
| # Process each Markdown file in the directory | ||
| for root, _, files in os.walk(args.directory): | ||
| for file in files: | ||
| if file.endswith(".md"): |
There was a problem hiding this comment.
Make this case insensitive. Do this for the other PR too
.github/workflows/script.py
Outdated
| @@ -0,0 +1,94 @@ | |||
| #!/usr/bin/env python3 | |||
| # -*- coding: UTF-8 -*- | |||
There was a problem hiding this comment.
Change the name of the script to be more self-explanatory. Do this for the other PR too
.github/workflows/script.py
Outdated
| # Escape MPX characters | ||
| new_content = escape_mpx_characters(content) | ||
|
|
||
| # Write the processed content back to the file |
There was a problem hiding this comment.
Only do this if there is a change. Do this for the other PR too.
|
Made necessary changes |
There was a problem hiding this comment.
- This works if there is only one update to the PR.
- What happens if a person submits a PR and then does multiple commits so that this script is run multiple times? It would add an excessive number of
\characters to the files. - You will need to ensure that
\<,\>,\{, and\}are not replaced with\\<,\\>,\\{, and\\}
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1314 +/- ##
========================================
Coverage 96.30% 96.30%
========================================
Files 137 137
Lines 3387 3387
Branches 949 949
========================================
Hits 3262 3262
Misses 119 119
Partials 6 6 ☔ View full report in Codecov by Sentry. |
What kind of change does this PR introduce?
npmfor bothtalawa-apiandtalawa-admin.script.py) to ensure Markdown files are MPX compatible.Issue Number: #1279
Did you add tests for your changes?
If relevant, did you update the documentation?
script.py.Summary
script.pyfor Typedoc-generated Markdown files.Does this PR introduce a breaking change?
Have you read the contributing guide?