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

Embed code snippets into README #342

Open
3 tasks
nifadyev opened this issue Oct 15, 2024 Discussed in #340 · 0 comments
Open
3 tasks

Embed code snippets into README #342

nifadyev opened this issue Oct 15, 2024 Discussed in #340 · 0 comments

Comments

@nifadyev
Copy link
Contributor

nifadyev commented Oct 15, 2024

Discussed in #340

Current contribution workflow contains a lot of duplication. For example, each translation duplicates code snippets and translates only comments.

Add support for embedded code Github Action
The goal is to store, test and analyze code snippets in one place, and reduce duplicity. It will probably break current interactive notebooks or CLI, their behavior should be checked. CI checks and validations, running snippets on various Python versions, automatic PR checks and so on.

UPD: It is important to note that Github code embedding is exclusive to Github. For example, it won't work in Jyputer notebook or static formats (epub, pdf). So called auto documentation should be considered as first option, some references:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant