DOC: Document ria url formats in docstring #6861

adswa · 2022-07-20T08:48:21Z

@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

create-sibling-ria's docstring now defines the schema of RIA URLs and clarifies internal layout of a RIA store.

mih · 2022-07-22T08:58:51Z

Ping @bpoldrack

bpoldrack · 2022-08-01T13:06:08Z

@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]

adswa · 2022-08-01T14:29:27Z

datalad/distributed/create_sibling_ria.py

+    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


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?

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.

Would you mind pushing a clarification?

adswa · 2022-08-01T14:30:43Z

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

datalad/distributed/create_sibling_ria.py

Co-authored-by: Benjamin Poldrack <bpoldrack@users.noreply.github.com>

codecov · 2022-08-01T16:56:45Z

Codecov Report

Base: 90.27% // Head: 91.17% // Increases project coverage by +0.90% 🎉

Coverage data is based on head (d1b6a36) compared to base (afc2ecf).
Patch has no changes to coverable lines.

❗ Current head d1b6a36 differs from pull request most recent head 1a7f653. Consider uploading reports for the commit 1a7f653 to get more accurate results

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

Impacted Files	Coverage Δ
datalad/distributed/create_sibling_ria.py	`81.76% <ø> (ø)`
datalad/downloaders/tests/utils.py	`92.30% <0.00%> (-7.70%)`	⬇️
datalad/api.py	`91.11% <0.00%> (-3.63%)`	⬇️
datalad/metadata/extractors/image.py	`96.77% <0.00%> (-3.23%)`	⬇️
datalad/metadata/extractors/exif.py	`96.87% <0.00%> (-3.13%)`	⬇️
datalad/tests/test_version.py	`80.00% <0.00%> (-2.86%)`	⬇️
datalad/metadata/extractors/audio.py	`97.14% <0.00%> (-2.86%)`	⬇️
datalad/support/entrypoints.py	`57.89% <0.00%> (-2.64%)`	⬇️
datalad/cli/tests/test_formatters.py	`97.82% <0.00%> (-2.18%)`	⬇️
datalad/local/remove.py	`95.38% <0.00%> (-1.54%)`	⬇️
... and 25 more

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.
📢 Do you have feedback about the report comment? Let us know in this issue.

mih · 2022-09-16T08:17:40Z

I am putting this into draft mode. There has been no activity in a while. Please close, if abandoned.

adswa · 2022-09-16T09:02:01Z

Oh I think the PR can actually just go in

adswa · 2022-10-19T20:10:12Z

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.

codeclimate · 2022-10-19T20:27:23Z

Code Climate has analyzed commit 325fb51 and detected 0 issues on this pull request.

View more on Code Climate.

bpoldrack · 2022-10-20T08:21:32Z

It would be nice to get this vetted by @bpoldrack so that the tiny doc fix for #6800 can finally make it in.

Yes, looks good to me. Thank you, @adswa.

yarikoptic-gitmate · 2022-12-31T20:17:43Z

PR released in 0.18.0

DOC: Start to document ria url formats in docstring - needs help

d8bef12

adswa assigned bpoldrack Jul 20, 2022

adswa added the semver-documentation Changes only affect the documentation, no impact on version label Jul 20, 2022

bpoldrack force-pushed the doc-6800 branch from c6fc9ea to f7dca9b Compare August 1, 2022 13:04

Enhance RIA docs

ec8b9df

- 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]

bpoldrack force-pushed the doc-6800 branch from f7dca9b to ec8b9df Compare August 1, 2022 14:12

adswa commented Aug 1, 2022

View reviewed changes

bpoldrack reviewed Aug 1, 2022

View reviewed changes

datalad/distributed/create_sibling_ria.py Outdated Show resolved Hide resolved

DOC: refine definition of dataset version identifier

d1b6a36

Co-authored-by: Benjamin Poldrack <bpoldrack@users.noreply.github.com>

mih mentioned this pull request Sep 8, 2022

Remove RIA functionality #7022

Closed

mih marked this pull request as draft September 16, 2022 08:17

adswa added 2 commits October 19, 2022 22:06

Reword RIA layout section - less scary, more pragmatic

076faca

Merge branch 'doc-6800' of github.com:datalad/datalad into doc-6800

1a7f653

adswa marked this pull request as ready for review October 19, 2022 20:10

Merge branch 'master' of github.com:datalad/datalad into doc-6800

325fb51

adswa changed the title ~~DOC: Start to document ria url formats in docstring - needs help~~ DOC: Document ria url formats in docstring Oct 19, 2022

bpoldrack merged commit 2346326 into master Oct 20, 2022

bpoldrack deleted the doc-6800 branch October 20, 2022 08:21

adswa mentioned this pull request Nov 10, 2022

DOC: document RIA URL format and versioning options #6800

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Document ria url formats in docstring #6861

DOC: Document ria url formats in docstring #6861

adswa commented Jul 20, 2022 •

edited by bpoldrack

Loading

mih commented Jul 22, 2022

bpoldrack commented Aug 1, 2022

adswa Aug 1, 2022

bpoldrack Aug 1, 2022 •

edited

Loading

adswa Aug 15, 2022

adswa commented Aug 1, 2022

codecov bot commented Aug 1, 2022 •

edited

Loading

mih commented Sep 16, 2022

adswa commented Sep 16, 2022

adswa commented Oct 19, 2022

codeclimate bot commented Oct 19, 2022

bpoldrack commented Oct 20, 2022

yarikoptic-gitmate commented Dec 31, 2022

DOC: Document ria url formats in docstring #6861

DOC: Document ria url formats in docstring #6861

Conversation

adswa commented Jul 20, 2022 • edited by bpoldrack Loading

Changelog

📝 Documentation

mih commented Jul 22, 2022

bpoldrack commented Aug 1, 2022

adswa Aug 1, 2022

Choose a reason for hiding this comment

bpoldrack Aug 1, 2022 • edited Loading

Choose a reason for hiding this comment

adswa Aug 15, 2022

Choose a reason for hiding this comment

adswa commented Aug 1, 2022

codecov bot commented Aug 1, 2022 • edited Loading

Codecov Report

mih commented Sep 16, 2022

adswa commented Sep 16, 2022

adswa commented Oct 19, 2022

codeclimate bot commented Oct 19, 2022

bpoldrack commented Oct 20, 2022

yarikoptic-gitmate commented Dec 31, 2022

adswa commented Jul 20, 2022 •

edited by bpoldrack

Loading

bpoldrack Aug 1, 2022 •

edited

Loading

codecov bot commented Aug 1, 2022 •

edited

Loading