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.

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

Improve --no-input documentation #1543

Closed
glumia opened this issue May 1, 2021 · 5 comments
Closed

Improve --no-input documentation #1543

glumia opened this issue May 1, 2021 · 5 comments
Labels
documentation This issue/PR relates to or includes documentation. good first issue issues and pull requests for new contributors

Comments

@glumia
Copy link
Contributor

glumia commented May 1, 2021

Check #1201 (comment).

Currently it isn't clear from the documentation what exactly cookiecutter's behaviour is in case the --no-input flag is provided.

We should add the information about template's cache refresh and check if there's something else missing (by looking at what happens when no_input is True in the source code).

@glumia glumia added the documentation This issue/PR relates to or includes documentation. label May 1, 2021
@simobasso simobasso added the good first issue issues and pull requests for new contributors label May 5, 2021
@jeremyswerdlow
Copy link
Contributor

Hi there, was looking at starting to contribute and thought this would be a good issue with which to begin. However, I see that in HISTORY.md there is an accreditation to @pokoli for their documentation on this flag.

Is this issue still valid?

@glumia
Copy link
Contributor Author

glumia commented Aug 5, 2021

Hi @jeremyswerdlow, yes it is still valid!

If you take a look at #701 you can see that it doesn't explain exactly what happens when you provide the --no-input flag on the command line (I remember noticing that templates cache refresh was only one of its undocumented side effects).

@jeremyswerdlow
Copy link
Contributor

Great! If it's alright I'll take over this issue then!

@jeremyswerdlow
Copy link
Contributor

Looks like the CR needs to be approved for testing by a maintainer, if someone has a chance

glumia pushed a commit to jeremyswerdlow/cookiecutter that referenced this issue Oct 26, 2021
insspb added a commit that referenced this issue Jun 6, 2022
Expand cli documentation relating to the no-input flag (#1543)
@insspb
Copy link
Member

insspb commented Jun 6, 2022

@jeremyswerdlow @glumia Thank you for contribution, will be in next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue/PR relates to or includes documentation. good first issue issues and pull requests for new contributors
Projects
None yet
Development

No branches or pull requests

4 participants