Skip to content
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

Runnable and testable code snippets #5

Open
niekdt opened this issue Jul 24, 2024 · 0 comments
Open

Runnable and testable code snippets #5

niekdt opened this issue Jul 24, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@niekdt
Copy link
Owner

niekdt commented Jul 24, 2024

Code snippets would be a lot more reliable if they are defined to be runnable and testable.

Possibilities:

  • More complete code examples for users, even showing output
  • Flagging broken snippets
  • Automatic supported-package version labeling
  • Version-specific views

However, this proposal greatly increases the amount of effort per code snippet, so this only becomes feasible with more support from other contributors.

@niekdt niekdt added the enhancement New feature or request label Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant