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

Document the available formats in the CLI #441

Merged
merged 6 commits into from
Feb 18, 2020
Merged

Conversation

mwouts
Copy link
Owner

@mwouts mwouts commented Feb 16, 2020

This relates to #433 and #426.

With this PR, the documentation of --to command of Jupytext becomes:

  --to TO               Destination format: either 'notebook' (extension .ipynb),
                        'markdown' (.md), 'rmarkdown' (.Rmd), 'script', a supported
                        extension, or an explicit extension/format description
                        [prefix_path//][suffix.]ext[:format_name], where
                        - ext is one of ipynb, md, markdown, Rmd, py, R, r, jl, cpp, ss, clj, scm, sh, ps1, q, m, pro, js, ts, scala, rs, robot, cs, fsx, fs, or auto
                        - format_name is optional, and can be markdown or pandoc for Markdown
                        files, and nomarker, light, percent, hydrogen, sphinx for scripts.
                        The default format for scripts is the 'light' format,
                        which uses few cell markers (none when possible).
                        Alternatively, a format compatible with many editors is the
                        'percent' format, which uses '# %%' as cell markers
                        The main formats (markdown, light, percent) preserve
                        notebooks and text documents in a roundtrip. Use the
                        --test and and --test-strict commands to test the roundtrip
                        on your files.
                        Read more about the available formats at
                        https://jupytext.readthedocs.io/en/latest/formats.html
                         (default: None)

@mwouts mwouts mentioned this pull request Feb 16, 2020
@codecov
Copy link

codecov bot commented Feb 16, 2020

Codecov Report

Merging #441 into master will increase coverage by 1.04%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #441      +/-   ##
==========================================
+ Coverage   97.98%   99.02%   +1.04%     
==========================================
  Files          77       77              
  Lines        7725     7726       +1     
==========================================
+ Hits         7569     7651      +82     
+ Misses        156       75      -81
Impacted Files Coverage Δ
jupytext/cli.py 95.64% <100%> (+0.01%) ⬆️
jupytext/version.py 100% <100%> (ø) ⬆️
jupytext/cell_metadata.py 98.66% <0%> (+0.33%) ⬆️
jupytext/formats.py 98.67% <0%> (+0.66%) ⬆️
tests/test_mirror.py 100% <0%> (+0.71%) ⬆️
tests/test_contentsmanager.py 100% <0%> (+1.07%) ⬆️
tests/test_cli.py 100% <0%> (+1.93%) ⬆️
jupytext/kernels.py 90% <0%> (+3.33%) ⬆️
jupytext/jupytext.py 98.59% <0%> (+4.22%) ⬆️
jupytext/pandoc.py 95.91% <0%> (+55.1%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3f857d5...989342b. Read the comment docs.

@mwouts mwouts merged commit a393afd into master Feb 18, 2020
@mwouts mwouts deleted the formats_in_jupytext_cli branch February 18, 2020 20:45
@Atcold
Copy link

Atcold commented Feb 20, 2020

Looks good to me. Thanks you.

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

Successfully merging this pull request may close these issues.

2 participants