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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

A couple of README issues #263

Open
saiwing-yeung opened this issue Jul 28, 2023 · 1 comment
Open

A couple of README issues #263

saiwing-yeung opened this issue Jul 28, 2023 · 1 comment
Labels
bug / fix Something isn't working help wanted Extra attention is needed

Comments

@saiwing-yeung
Copy link

馃悰 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

  1. In "On the other hand we highly recommend creating a notebooks and convert it script with jupytext as", there are a couple of issues. It should be just "notebooks" instead of "a notebooks" and something like "convert it using jupytext".
  2. The jupytext command also doesn't work because the command tries to read an ipynb file 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 like jupytext --output input.py output.ipynb
@saiwing-yeung saiwing-yeung added bug / fix Something isn't working help wanted Extra attention is needed labels Jul 28, 2023
@Borda
Copy link
Member

Borda commented Oct 12, 2023

Thank you for taking the time and validate our readme, could you please send a PR with suggestions? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug / fix Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants