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.

Sign up for GitHub

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

Jump to bottom

update documents to reflect new default format #564

Closed
edublancas opened this issue Feb 8, 2022 · 1 comment
Closed

update documents to reflect new default format #564

edublancas opened this issue Feb 8, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@edublancas
Copy link
Contributor

initially, we were using the py:light format as the default one for scripts:

# +
x = 1

# +
y = 2

However, we're now migrating to the percent format to be the default, since VSCode, PyCharm, and others support it:

# %%
x = 1

# %%
y = 2

Some sections in our documentation need updates:

https://docs.ploomber.io/en/latest/user-guide/jupyter.html
https://docs.ploomber.io/en/latest/get-started/basic-concepts.html

I found these two but there may be others.
@edublancas edublancas added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 8, 2022
@idomic
Copy link
Contributor

idomic commented Feb 9, 2022

@hypefi wanna take a stab at it?

hypefi added a commit to hypefi/ploomber that referenced this issue Feb 10, 2022
@hypefi
updating documantation to reflect new default format percent ploomber…
9b63b11 
…#564
edublancas pushed a commit that referenced this issue Feb 21, 2022
@hypefi
update documents to reflect new default format #564 (#578)
a85a156 
* adding typo handling and updating tests for: cli should suggest the appropriate command if there's a typo #523

* adding typo handling and updating tests for: cli should suggest the appropriate command if there's a typo #523

* Correct linting

* updating documantation to reflect new default format percent #564
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@edublancas @idomic