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

Typo in basic_usage.rst #1017

Open
vit-smilauer opened this issue Jan 16, 2025 · 1 comment
Open

Typo in basic_usage.rst #1017

vit-smilauer opened this issue Jan 16, 2025 · 1 comment
Labels
doc PR tag for additions to the documentation

Comments

@vit-smilauer
Copy link

Dear developers,
thank you for your package, which is very instructive for students. I found a few typos in the https://porespy.org/basic_usage.html, particularly:

cr = ps.filters.flood(cr, mode='size') -> TypeError: flood() missing 1 required positional argument: 'labels'
data = ps.metrics.two_point_correlation(im) <- function renamed from two_point_correlation_fft()
fig = plt.plot(*data, 'bo-') <- fig = plt.plot(data.distance, data.pdf, 'bo-')

Best regards. Vit

@ma-sadeghi ma-sadeghi changed the title Basic Usage - typos Typo in basic_usage.rst Jan 16, 2025
@ma-sadeghi ma-sadeghi added the doc PR tag for additions to the documentation label Jan 16, 2025
@ma-sadeghi
Copy link
Member

Thanks for reporting the typo.

@jgostick Might as well turn basic_usage.rst into a notebook, so it can be tested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc PR tag for additions to the documentation
Projects
None yet
Development

No branches or pull requests

2 participants