DOC: Provide dataset information in fetcher script help #48
Conversation
This file contains hidden or 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
github-actions
bot
added
the
type:documentation
jhlegarreta
force-pushed
the
AddZenodoLinkToFetcherScriptHelp
branch
from
ca030d6 to
7bdd7f0
Compare
github-actions
bot
added
area:io
jhlegarreta
changed the title
jhlegarreta
force-pushed
the
AddZenodoLinkToFetcherScriptHelp
branch
from
7bdd7f0 to
28e166f
Compare
github-actions
bot
added
type:documentation
github-actions
bot
added
type:documentation
Contributor
Author
|
This was passing yesterday, and it is now failing with the same error as in #49 (comment) after today's push force. Definitely errors are not related to the patch sets. |
Contributor
Author
#50 fixes the issues. |
jhlegarreta
force-pushed
the
AddZenodoLinkToFetcherScriptHelp
branch
from
cbef0bb to
90c4750
Compare
github-actions
bot
added
type:documentation
jhlegarreta
force-pushed
the
AddZenodoLinkToFetcherScriptHelp
branch
from
90c4750 to
55a4b50
Compare
github-actions
bot
added
type:documentation
Provide dataset information in fetcher script description: add the dataset description and the zenodo links where the datasets dwell to the fetcher script description so that they are shown when the help is shown.
jhlegarreta
force-pushed
the
AddZenodoLinkToFetcherScriptHelp
branch
from
55a4b50 to
1d48465
Compare
github-actions
bot
added
type:documentation
jhlegarreta
force-pushed
the
AddZenodoLinkToFetcherScriptHelp
branch
from
1d48465 to
acbbe6b
Compare
github-actions
bot
added
type:documentation
Use the fetcher method callable provider in the dataset retrieval method. Improves code re-use.
Remove "Download" from the fetcher method descriptions for the sake of consistency across descriptions, and in order to describe the dataset itself rather than the method.
Refactor the dataset parameters tuples: - The dataset tuples do not provide an effective fetcher, but only the parameters needed to make the fetcher. Thus, the `fetcher_` prefix is removed. - Rename the method that provides the fetcher parameters accordingly. - The fetcher names are all built in the same way, and thus this is put into a method for the sake of best coding practices. Also, prefer naming the fetchers directly using the Dataset enum values.
jhlegarreta
force-pushed
the
AddZenodoLinkToFetcherScriptHelp
branch
from
acbbe6b to
41d5931
Compare
github-actions
bot
added
type:documentation
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs, but you will still be able to re-open it. Thank you for your contributions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Resolves #44.