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.

Sign up for GitHub

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

Jump to bottom

DOC: Provide dataset information in fetcher script help #48

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

DOC: Provide dataset information in fetcher script help #48

wants to merge 4 commits into from

Conversation

jhlegarreta
Copy link
Contributor

@jhlegarreta jhlegarreta commented Feb 13, 2023 •
edited
Loading

  • DOC: Provide dataset information in fetcher script help
  • ENH: Use the fetcher method callable provider in dataset retrieval
  • STYLE: Remove "Download" from the fetcher method descriptions
  • ENH: Refactor the dataset parameters tuples

Resolves #44.

@github-actions github-actions bot added the type:documentation Improvements or additions to documentation label Feb 13, 2023
@jhlegarreta jhlegarreta force-pushed the AddZenodoLinkToFetcherScriptHelp branch from ca030d6 to 7bdd7f0 Compare February 14, 2023 18:26
@github-actions github-actions bot added area:io Items affecting the io module type:documentation Improvements or additions to documentation and removed type:documentation Improvements or additions to documentation labels Feb 14, 2023
@jhlegarreta jhlegarreta changed the title DOC: Add links to zenodo datasets in fetcher script description DOC: Provide dataset information in fetcher script help Feb 14, 2023
@jhlegarreta jhlegarreta force-pushed the AddZenodoLinkToFetcherScriptHelp branch from 7bdd7f0 to 28e166f Compare February 14, 2023 18:33
@github-actions github-actions bot added type:documentation Improvements or additions to documentation and removed type:documentation Improvements or additions to documentation labels Feb 14, 2023
@jhlegarreta jhlegarreta mentioned this pull request Feb 14, 2023
Open
@github-actions github-actions bot added type:documentation Improvements or additions to documentation and removed type:documentation Improvements or additions to documentation labels Feb 14, 2023
@jhlegarreta
Copy link
Contributor Author

jhlegarreta commented Feb 15, 2023 •
edited
Loading

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.

@jhlegarreta
Copy link
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.

#50 fixes the issues.

@jhlegarreta jhlegarreta force-pushed the AddZenodoLinkToFetcherScriptHelp branch from cbef0bb to 90c4750 Compare March 3, 2023 17:42
@github-actions github-actions bot added type:documentation Improvements or additions to documentation and removed type:documentation Improvements or additions to documentation labels Mar 3, 2023
@jhlegarreta jhlegarreta force-pushed the AddZenodoLinkToFetcherScriptHelp branch from 90c4750 to 55a4b50 Compare March 3, 2023 17:54
@github-actions github-actions bot added type:documentation Improvements or additions to documentation and removed type:documentation Improvements or additions to documentation labels Mar 3, 2023
@jhlegarreta
DOC: Provide dataset information in fetcher script help
22a8304 
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 jhlegarreta force-pushed the AddZenodoLinkToFetcherScriptHelp branch from 55a4b50 to 1d48465 Compare March 3, 2023 18:01
@github-actions github-actions bot added type:documentation Improvements or additions to documentation and removed type:documentation Improvements or additions to documentation labels Mar 3, 2023
@jhlegarreta jhlegarreta force-pushed the AddZenodoLinkToFetcherScriptHelp branch from 1d48465 to acbbe6b Compare March 3, 2023 18:17
@github-actions github-actions bot added type:documentation Improvements or additions to documentation and removed type:documentation Improvements or additions to documentation labels Mar 3, 2023
@jhlegarreta
ENH: Use the fetcher method callable provider in dataset retrieval
907b5be 
Use the fetcher method callable provider in the dataset retrieval
method. Improves code re-use.
@jhlegarreta
STYLE: Remove "Download" from the fetcher method descriptions
e488075 
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.
@jhlegarreta
ENH: Refactor the dataset parameters tuples
41d5931 
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 jhlegarreta force-pushed the AddZenodoLinkToFetcherScriptHelp branch from acbbe6b to 41d5931 Compare March 3, 2023 18:34
@github-actions github-actions bot added type:documentation Improvements or additions to documentation and removed type:documentation Improvements or additions to documentation labels Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
area:io Items affecting the io module type:documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Zenodo links to the fetch data
1 participant
@jhlegarreta