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

documentation: Fix nits on the first marimo notebook #3933

Merged
merged 4 commits into from
Feb 18, 2025

Conversation

compor
Copy link
Collaborator

@compor compor commented Feb 18, 2025

Minor nits and rewording of sentences.

@compor compor added the documentation Improvements or additions to documentation label Feb 18, 2025
@compor compor self-assigned this Feb 18, 2025
@compor compor changed the title documentation: documentation: Fix nits on the first marimo notebook Feb 18, 2025
Comment on lines +110 to +115
_first_info_text = exercise_text(
first_text_area.value,
"first",
((1, 2), (3, 4)),
("first(1, 2) = ", "first(3, 4) = "),
)
Copy link
Collaborator Author

@compor compor Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our ruff formatting excludes notebooks, so it's my local settings I assume.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you editing the raw python locally or using marimo edit?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Raw python locally, do you want me to run with the editor? I'll see if it can reformat these.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it would be good to run it in the editor, before merging because they have their own formatter that will likely conflict with your changes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, there is no "format all cells", I have to go over each cell and do a ctrl-b

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Run all cells" seems to do it

Copy link

codecov bot commented Feb 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.30%. Comparing base (5cf9f7d) to head (5e06f47).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3933   +/-   ##
=======================================
  Coverage   91.30%   91.30%           
=======================================
  Files         467      467           
  Lines       58068    58068           
  Branches     5581     5581           
=======================================
  Hits        53021    53021           
  Misses       3616     3616           
  Partials     1431     1431           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


A module is a unit of code which holds a single region.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regions are not explained, so my main issue here is adding a definition earlier or omitting all together.
I'm inclined to do that later.

Copy link
Member

@superlopuh superlopuh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thank you

@compor compor merged commit 64e86a7 into main Feb 18, 2025
16 checks passed
@compor compor deleted the christos/docs/marimo-nb-1 branch February 18, 2025 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants