-
Notifications
You must be signed in to change notification settings - Fork 191
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.
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
Changes to nf-core pipelines download CLI #3178
Changes to nf-core pipelines download CLI #3178
Conversation
Hi @MatthiasZepper, thanks for this PR. Docs are now on the website repo here. |
Thanks for taking a look already.
Because I have occasionally received complaints similar to #3043 and the prompt for downloading the configs was one of them. Technically, I never felt it was a pressing issue, but kept it in the back of my head for the next major version jump. |
3efd160
to
960f202
Compare
960f202
to
5dea0d0
Compare
I would keep it as a flag. Pointing towards the one-liner approach suggested by @ewels should be enough. |
But the download configuration prompt and the |
okay, then I misunderstood why you linked the issue... just for clarity's sake: one can add the also the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, we are only missing updating the docs for these changes. Is this PR ready to be merged @MatthiasZepper ?
I did not know that. I also do not find it in the code. So how does that work? if not self.platform and self.include_configs is None:
self.prompt_config_inclusion()
From my side, absolutely, since there is seemingly no need to address the CACHE DIR issue, since the OP did never reply. But I do not think that @mashehu is happy with the other changes yet? |
the env. variable thing comes with click: https://click.palletsprojects.com/en/8.1.x/options/#values-from-environment-variables |
This PR suggests a change to the CLI of
nf-core download
respectively nownf-core pipelines download
.To free the
-p
flag for Seqera Platform, the-d
flag was needed for--parallel-downloads
and thus--download-configs
had to change from-d
to-c
.This is also more consistent, since most short flags use the first letter of the last word as the short flag, e.g.
-l
for--container-library
or-u
for--container-cache-utilisation
.Furthermore,
-t
/--tower
has now been entirely removed as it was deprecated before. Therefore-t
could have been used for--tag
in the future, but there is hardly a point of having a short flag for a three letter argument, so I refrained from introducing it.PR checklist
CHANGELOG.md
is updatedDocumentation inDoes that still apply? I looked into the newdocs
is updateddocs
folder, but it seems the old manual Markdown was replaced by some autogenerated API documentation:docs/api/_src/api/pipelines/download.md