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

Add param documentation for overwrite_if_exists #1808

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

Conversation

inktrap
Copy link

@inktrap inktrap commented Jan 4, 2023

@inktrap
Copy link
Author

inktrap commented Jan 4, 2023

But skip_if_file_exists is also not documented and if I look at the API docs it seems to be undocumented by choice. Other paramters with default values however are documented. What's you preferred way of doing this?

@inktrap
Copy link
Author

inktrap commented Jan 4, 2023

I just wanted to clarify: while the params are documented through the options: https://cookiecutter.readthedocs.io/en/stable/cli_options.html I looked for a way to combine two different cookiecutter templates and then to use the result. That way I can write my own additions without the need to fork a project. This should work pretty well with a minimal base cookiecutter.

For that to work I would have to know if overwriting is some kind of merging (files are overwritten as they are encountered) or if it is a fresh start (the whole directory is removed and then recreated).

Obviously I can figure this out by reading the source, just wanted to explain why it would be good if kind of obvious parameters had some docs too

@liortct

This comment was marked as off-topic.

Copy link
Member

@kurtmckee kurtmckee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jensens @pydanny @ssbarnea Please merge this PR.

It addresses missing parameter documentation so the parameter will appear in the API docs.

@jensens jensens added the documentation This issue/PR relates to or includes documentation. label Jun 12, 2023
cookiecutter/main.py Outdated Show resolved Hide resolved
cookiecutter/main.py Outdated Show resolved Hide resolved
@ericof ericof added this to the 2.2.0 milestone Jun 13, 2023
@ericof ericof modified the milestones: 2.2.0, 3.0.0 Jul 6, 2023
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants