Title: [CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documents · Issue #2848 · exercism/python · GitHub
Open Graph Title: [CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documents · Issue #2848 · exercism/python
X Title: [CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documents · Issue #2848 · exercism/python
Description: This came up in discussing PR #2838, so opening an issue here for longer discussion/evaluation. We currently "hand validate" example python code used in introduction.md, about.md, and instruction.md and similar documents. This leads to e...
Open Graph Description: This came up in discussing PR #2838, so opening an issue here for longer discussion/evaluation. We currently "hand validate" example python code used in introduction.md, about.md, and instruction.m...
X Description: This came up in discussing PR #2838, so opening an issue here for longer discussion/evaluation. We currently "hand validate" example python code used in introduction.md, about.md, and ins...
Opengraph URL: https://github.com/exercism/python/issues/2848
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documents","articleBody":"This came up in discussing PR #2838, so opening an issue here for longer discussion/evaluation.\r\n\r\nWe currently \"hand validate\" example python code used in `introduction.md`, `about.md`, and `instruction.md` and similar documents. This leads to errors where certain code will not work in the REPL, or syntax or other errors get made and published. As we scale up exercises, this doesn't feel like a sustainable solution, hence this issue to propose, evaluate, and track possible tools and strategies for verifying code , and (possibly) adding that verification to the track CI. \r\n\r\nBelow are three applicable libraries, but I'd warmly welcome more. Of the three below, `pmdoctest` feels like the nicest solution, and I've run the `comparisons` concept exercise through it with reasonable results. But I'd like to see if there are other strategies/libraries out there.\r\n\r\n\r\n[doctest](https://docs.python.org/3/library/doctest.html) - this is the old-school original, but doesn't really work well in markdown fences.\r\n[mkcodes](https://github.com/ryneeverett/mkcodes) - have not tried this yet.\r\n[pmdoctest](https://tmarktaylor.github.io/phmdoctest/) - reasonably good, but requires some weird quirks with code fence language names and or excess `\u003e\u003e\u003e` in code fences to make parsing work.","author":{"url":"https://github.com/BethanyG","@type":"Person","name":"BethanyG"},"datePublished":"2022-01-09T22:00:14.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/2848/python/issues/2848"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:1e40920e-a311-3132-0da8-47578980cb7f |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9BBA:3119CD:A370EB:E5E16C:69690CD3 |
| html-safe-nonce | c6f7a74e4f933f8a2c57e65c3810a224de6abdd3fa2d8b4dcd34908ff34d928e |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5QkJBOjMxMTlDRDpBMzcwRUI6RTVFMTZDOjY5NjkwQ0QzIiwidmlzaXRvcl9pZCI6IjMwMDk4NDk1NTE2NDkwNDk4MTEiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 64bb9bbb93e4c21a8e7187c988abedf8a4095e4136bf2f973ed27f29378a893c |
| hovercard-subject-tag | issue:1097313211 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/exercism/python/2848/issue_layout |
| twitter:image | https://opengraph.githubassets.com/4f18329a44c7505d7fd897d456d33a944ea75554c2c16152ecb116f199744a6a/exercism/python/issues/2848 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/4f18329a44c7505d7fd897d456d33a944ea75554c2c16152ecb116f199744a6a/exercism/python/issues/2848 |
| og:image:alt | This came up in discussing PR #2838, so opening an issue here for longer discussion/evaluation. We currently "hand validate" example python code used in introduction.md, about.md, and instruction.m... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | BethanyG |
| hostname | github.com |
| expected-hostname | github.com |
| None | e6156bd4ef9f2dc8dadf4c49a8f7ed8532186388cef72eda3ccb9f0ab3b8cfca |
| turbo-cache-control | no-preview |
| go-import | github.com/exercism/python git https://github.com/exercism/python.git |
| octolytics-dimension-user_id | 5624255 |
| octolytics-dimension-user_login | exercism |
| octolytics-dimension-repository_id | 17274389 |
| octolytics-dimension-repository_nwo | exercism/python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 17274389 |
| octolytics-dimension-repository_network_root_nwo | exercism/python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | ee2210c3e58153aae53400c942f8a7b4bbb43ec4 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width