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 usage to docs #135

Merged
merged 10 commits into from
Jan 6, 2025
Merged

Conversation

veni-vidi-vici-dormivi
Copy link
Collaborator

Moved README content to usage.rst and rewrote the README.

@veni-vidi-vici-dormivi
Copy link
Collaborator Author

Happy to receive input on the README @mathause :)

Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
unittests 99.68% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@mathause
Copy link
Collaborator

mathause commented Jan 6, 2025

I realized that the repr of the FileContainer is no longer correct. Also I would now simplify the example files: /root/a1/a1_file_1 -> /root/a/a_file_1 to only have one number. I can do that in a follow up.

@veni-vidi-vici-dormivi
Copy link
Collaborator Author

Done :)

Copy link
Collaborator

@mathause mathause left a comment

Choose a reason for hiding this comment

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

Oh I forgot to send the review.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Mathias Hauser <[email protected]>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@veni-vidi-vici-dormivi
Copy link
Collaborator Author

Very nice! :)

@veni-vidi-vici-dormivi veni-vidi-vici-dormivi merged commit 30d04f2 into mpytools:main Jan 6, 2025
6 checks passed
@mathause
Copy link
Collaborator

mathause commented Jan 6, 2025

Oh these typos also hide in the regionmask README 😮 Thanks.

@mathause
Copy link
Collaborator

mathause commented Jan 6, 2025

But its was correct, no? As possessive determiner.

@veni-vidi-vici-dormivi
Copy link
Collaborator Author

Omg you are right, sorry 😅 🙈

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