René's URL Explorer Experiment


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

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:1e40920e-a311-3132-0da8-47578980cb7f
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id9BBA:3119CD:A370EB:E5E16C:69690CD3
html-safe-noncec6f7a74e4f933f8a2c57e65c3810a224de6abdd3fa2d8b4dcd34908ff34d928e
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5QkJBOjMxMTlDRDpBMzcwRUI6RTVFMTZDOjY5NjkwQ0QzIiwidmlzaXRvcl9pZCI6IjMwMDk4NDk1NTE2NDkwNDk4MTEiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac64bb9bbb93e4c21a8e7187c988abedf8a4095e4136bf2f973ed27f29378a893c
hovercard-subject-tagissue:1097313211
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/exercism/python/2848/issue_layout
twitter:imagehttps://opengraph.githubassets.com/4f18329a44c7505d7fd897d456d33a944ea75554c2c16152ecb116f199744a6a/exercism/python/issues/2848
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/4f18329a44c7505d7fd897d456d33a944ea75554c2c16152ecb116f199744a6a/exercism/python/issues/2848
og:image:altThis 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameBethanyG
hostnamegithub.com
expected-hostnamegithub.com
Nonee6156bd4ef9f2dc8dadf4c49a8f7ed8532186388cef72eda3ccb9f0ab3b8cfca
turbo-cache-controlno-preview
go-importgithub.com/exercism/python git https://github.com/exercism/python.git
octolytics-dimension-user_id5624255
octolytics-dimension-user_loginexercism
octolytics-dimension-repository_id17274389
octolytics-dimension-repository_nwoexercism/python
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id17274389
octolytics-dimension-repository_network_root_nwoexercism/python
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releaseee2210c3e58153aae53400c942f8a7b4bbb43ec4
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/exercism/python/issues/2848#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fexercism%2Fpython%2Fissues%2F2848
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fexercism%2Fpython%2Fissues%2F2848
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=exercism%2Fpython
Reloadhttps://github.com/exercism/python/issues/2848
Reloadhttps://github.com/exercism/python/issues/2848
Reloadhttps://github.com/exercism/python/issues/2848
exercism https://github.com/exercism
pythonhttps://github.com/exercism/python
Please reload this pagehttps://github.com/exercism/python/issues/2848
Notifications https://github.com/login?return_to=%2Fexercism%2Fpython
Fork 1.5k https://github.com/login?return_to=%2Fexercism%2Fpython
Star 2.3k https://github.com/login?return_to=%2Fexercism%2Fpython
Code https://github.com/exercism/python
Issues 19 https://github.com/exercism/python/issues
Pull requests 13 https://github.com/exercism/python/pulls
Actions https://github.com/exercism/python/actions
Projects 0 https://github.com/exercism/python/projects
Security Uh oh! There was an error while loading. Please reload this page. https://github.com/exercism/python/security
Please reload this pagehttps://github.com/exercism/python/issues/2848
Insights https://github.com/exercism/python/pulse
Code https://github.com/exercism/python
Issues https://github.com/exercism/python/issues
Pull requests https://github.com/exercism/python/pulls
Actions https://github.com/exercism/python/actions
Projects https://github.com/exercism/python/projects
Security https://github.com/exercism/python/security
Insights https://github.com/exercism/python/pulse
New issuehttps://github.com/login?return_to=https://github.com/exercism/python/issues/2848
New issuehttps://github.com/login?return_to=https://github.com/exercism/python/issues/2848
[CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documentshttps://github.com/exercism/python/issues/2848#top
discussion 💬https://github.com/exercism/python/issues?q=state%3Aopen%20label%3A%22discussion%20%F0%9F%92%AC%22
https://github.com/BethanyG
https://github.com/BethanyG
BethanyGhttps://github.com/BethanyG
on Jan 9, 2022https://github.com/exercism/python/issues/2848#issue-1097313211
#2838https://github.com/exercism/python/pull/2838
doctesthttps://docs.python.org/3/library/doctest.html
mkcodeshttps://github.com/ryneeverett/mkcodes
pmdoctesthttps://tmarktaylor.github.io/phmdoctest/
discussion 💬https://github.com/exercism/python/issues?q=state%3Aopen%20label%3A%22discussion%20%F0%9F%92%AC%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.