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

Add example to README.md #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add example to README.md #17

wants to merge 1 commit into from

Conversation

dgegen
Copy link

@dgegen dgegen commented Jun 7, 2024

Hi there!

I am really glad that I found this project. However, it took me some time in the beginning to figure out how to use nbstriout-fast. This pull request adds a beginner-friendly example that illustrates one possible use of nbstriout-fast with Git filters. I think this will make this package accessible to a wider audience and, thus, help it get the attention it deserves.

Please feel free to provide any feedback or suggestions!

Cheers,
David

Add a beginner-friendly example to illustrate the use of `nbstripout-fast`.
Copy link
Collaborator

@peytondmurray peytondmurray 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 really well written, thanks for the contribution!

In practice I think a lot of folks will want to use this in a pre-commit hook, but I'll leave that for a later addition to the docs :)

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