Conversation
adswa
added
the
semver-documentation
|
Ping @bpoldrack |
|
@adswa : Pushed. Is that commit fine with you? |
- Complete RIA-URL section and use the 'scheme' term in context of a URL instead of 'protocol' - Add a warning on in-store layout with respect to its git-annex object tree - Point out, how both - bare repo and object tree - are actually optional [ci skip]
| UUID or a ~ symbol followed by the dataset's alias name: | ||
| 'ria+[scheme]://<storelocation>#<dataset-UUID>' or | ||
| 'ria+[scheme]://<storelocation>#~<aliasname>'. | ||
| In addition, specific version identifiers can be appended to the URL with an |
There was a problem hiding this comment.
Citing the original issue:
Adding @something to a working URL seems to look for a branch with that name, seems not to work for other tree-ish (commit, tag).
Does it only work for branches? If if only works for branches, should that be made clear?
There was a problem hiding this comment.
True. It's passed onto the --branch option to git clone, which considers branches and tags.
We'd probably want to change that, I think, but that's how it is and doc should reflect it.
There was a problem hiding this comment.
Would you mind pushing a clarification?
|
Thanks! I just re-raised one question from the original issue. And maybe we should also add examples. I can see if I have time today |
Co-authored-by: Benjamin Poldrack <bpoldrack@users.noreply.github.com>
Codecov ReportBase: 90.27% // Head: 91.17% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #6861 +/- ##
==========================================
+ Coverage 90.27% 91.17% +0.90%
==========================================
Files 354 354
Lines 46108 46399 +291
==========================================
+ Hits 41622 42303 +681
+ Misses 4486 4096 -390
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
I am putting this into draft mode. There has been no activity in a while. Please close, if abandoned. |
|
Oh I think the PR can actually just go in |
|
I have pushed a commit rephrasing the layout section into something that I feel is more pragmatic/non-technical and less vaguely scary. It would be nice to get this vetted by @bpoldrack so that the tiny doc fix for #6800 can finally make it in. |
|
Code Climate has analyzed commit 325fb51 and detected 0 issues on this pull request. View more on Code Climate. |
adswa
changed the title
Yes, looks good to me. Thank you, @adswa. |
|
PR released in |
4 participants
@bpoldrack, I made a start at fixing #6800, which asks for docs for RIA URLs. Can you fill in the TODO in this docstring?
This PR can also be a place for additional commits that fix #6860
Changelog
📝 Documentation