This repository was archived by the owner on Aug 28, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 81
A couple of README issues #263
Copy link
Copy link
Open
Labels
bug / fixSomething isn't workingSomething isn't workinghelp wantedExtra attention is neededExtra attention is neededwon't fixThis will not be worked onThis will not be worked on
Description
🐛 Bug
There are a couple of documentation issues in the README.
To Reproduce
Steps to reproduce the behavior:
The README says
This repo in main branch contain only python scripts with markdown extensions, and notebooks are generated in special publication branch, so no raw notebooks are accepted as PR. On the other hand we highly recommend creating a notebooks and convert it script with jupytext as
jupytext --set-formats ipynb,py:percent my-notebook.ipynb
Expected behavior
- In "On the other hand we highly recommend creating a notebooks and convert it script with
jupytextas", there are a couple of issues. It should be just "notebooks" instead of "a notebooks" and something like "convert it usingjupytext". - The
jupytextcommand also doesn't work because the command tries to read anipynbfile when we only provide Python scripts. Also I think for most users they don't need to sync the notebook and Python script and just need to convert from a script to a notebook. So it might be simpler to give a command likejupytext --output input.py output.ipynb
Metadata
Metadata
Assignees
Labels
bug / fixSomething isn't workingSomething isn't workinghelp wantedExtra attention is neededExtra attention is neededwon't fixThis will not be worked onThis will not be worked on