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

Update README #26

Merged
merged 8 commits into from
Nov 11, 2024
Merged

Update README #26

merged 8 commits into from
Nov 11, 2024

Conversation

m-wierzba
Copy link
Contributor

This is a first (but by no means final) attempt at providing a more complete documentation of the project. Some sections (e.g. synopsis) will likely be moved elsewhere at some point.

This is a first attempt at providing a more complete documentation of
the project. Some sections (e.g. synopsis) will likely be moved
elsewhere at some point.
Copy link
Member

@mih mih left a comment

Choose a reason for hiding this comment

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

Thanks! That was very helpful!

Here is a first wave of comments. Not so much on the README itself, but on the state of the implementation it is describing.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@mslw mslw left a comment

Choose a reason for hiding this comment

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

Thanks, I think it is a nice rework of the README.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@christian-monch christian-monch left a comment

Choose a reason for hiding this comment

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

Thanks a lot for writing this. I have a few comments, that you might address,

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
- Hide implementation details (URL, URL-KEY, FILE-KEY)
- Make use of git annex info
@m-wierzba
Copy link
Contributor Author

m-wierzba commented Nov 8, 2024

I think it is now ready to merge, but pinging @christian-monch to double-check.

@codecov-commenter
Copy link

codecov-commenter commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.77%. Comparing base (96219fc) to head (7f16ca2).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
+ Coverage   91.52%   91.77%   +0.24%     
==========================================
  Files          18       18              
  Lines         802      802              
  Branches       62       62              
==========================================
+ Hits          734      736       +2     
+ Misses         51       49       -2     
  Partials       17       17              

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

@christian-monch christian-monch merged commit a860db1 into datalad:main Nov 11, 2024
5 checks passed
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.

5 participants