DOC: Reference handbook documentation in add_readme #4991
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yarikoptic
requested changes
Oct 7, 2020
There was a problem hiding this comment.
surprise surprise -- tests fail for a "legit" reason:
======================================================================
FAIL: datalad.plugin.tests.test_plugins.test_add_readme
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/travis/virtualenv/python3.7.1/lib/python3.7/site-packages/nose/case.py", line 198, in runTest
self.test(*self.arg)
File "/home/travis/virtualenv/python3.7.1/lib/python3.7/site-packages/datalad/tests/utils.py", line 554, in _wrap_with_tree
return t(*(arg + (d,)), **kw)
File "/home/travis/virtualenv/python3.7.1/lib/python3.7/site-packages/datalad/plugin/tests/test_plugins.py", line 241, in test_add_readme
id=ds.id))
AssertionError: '# Dataset "demo_ds"\n\nthis is for play\n\n### Authors\n\n- Betty\n- Tom\n\n### License\n\nPDDL\n\n## General information\n\nThis is a DataLad dataset (id: 94667534-8bbe-41ad-8c53-a712a75734ac).\n\nFor more information on DataLad and on how to work with its datasets,\nsee the DataLad documentation at: http://handbook.datalad.org\n' != '# Dataset "demo_ds"\n\nthis is for play\n\n### Authors\n\n- Betty\n- Tom\n\n### License\n\nPDDL\n\n## General information\n\nThis is a DataLad dataset (id: 94667534-8bbe-41ad-8c53-a712a75734ac).\n\nFor more information on DataLad and on how to work with its datasets,\nsee the DataLad documentation at: http://docs.datalad.org\n'
|
ha, crap ;-) I thought "I wouldn't need to run the tests for that change" - will adjust the test. |
This replaces a link to docs.datalad.org with handbook.datalad.org in the README placeholder that is created with add_readme.py The test for the function is adjusted accordingly.
Codecov Report
@@ Coverage Diff @@
## master #4991 +/- ##
==========================================
+ Coverage 90.03% 90.09% +0.06%
==========================================
Files 292 292
Lines 40984 41005 +21
==========================================
+ Hits 36900 36945 +45
+ Misses 4084 4060 -24
Continue to review full report at Codecov.
|
|
Thanks @adswa. The remaining failures are unrelated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I saw that hirni uses
add_readme.pyto populate studydatasets with a placeholder README (withincfg_hirni). This change makes the README reference the handbook as documentation instead of docs.datalad.org.