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: add helpers for marimo things to be shared across notebooks #3712

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

superlopuh
Copy link
Member

We want to have more than one notebook, and a consistent way of showing things in them. I think a helpers file would be a good way to do that.

The main question is where we want the code to live, I think xdsl.utils.marimo makes sense, but I'm open to suggestions.

@superlopuh superlopuh added the documentation Improvements or additions to documentation label Jan 7, 2025
@superlopuh superlopuh self-assigned this Jan 7, 2025
@math-fehr
Copy link
Collaborator

xdsl.docs.marimo?
Is there a reason we want to put them all in the same place btw? Compared to order them by doc, tutorial, etc..?

Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.31%. Comparing base (b943df3) to head (5005e6f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3712      +/-   ##
==========================================
- Coverage   91.32%   91.31%   -0.01%     
==========================================
  Files         467      468       +1     
  Lines       58543    58546       +3     
  Branches     5652     5652              
==========================================
  Hits        53463    53463              
- Misses       3628     3631       +3     
  Partials     1452     1452              

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

@superlopuh
Copy link
Member Author

Hmm, it's really just reusable UI elements, not the full notebooks. The notebooks will still live in the docs folder, and you're right that they should be grouped together in some way. This seems like an orthogonal proposal, unless I'm misunderstanding you.

@math-fehr
Copy link
Collaborator

Nope my bad, I misunderstood you, looks good how it is now!

@superlopuh superlopuh merged commit a0d424d into main Jan 7, 2025
16 checks passed
@superlopuh superlopuh deleted the sasha/autotuner/marimo-helpers branch January 7, 2025 13:05
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