Skip to content

Add missing "parent dir" symbol in tutorial 2#1932

Merged
ericof merged 1 commit intocookiecutter:mainfrom
tvoirand:typo-in-tutorial
Sep 21, 2023
Merged

Add missing "parent dir" symbol in tutorial 2#1932
ericof merged 1 commit intocookiecutter:mainfrom
tvoirand:typo-in-tutorial

Conversation

@tvoirand
Copy link
Copy Markdown
Contributor

I think I found a typo in tutorial 2 Create a Cookiecutter From Scratch, when trying to reproduce it and getting stuck at [packing cookiecutter into ZIP](https://cookiecutter.readthedocs.io/en/stable/tutorials/tutorial2.html#step-5-pack-cookiecutter-into-zip.

I was able to pack the cookiecutter after adding a parent directory symbol, which was apparently missing in line 2 of the packing script (unless I misunderstood something, which is also probable because I am not familiar with pushd and popd).

Please feel free to merge/close without comment!

Copy link
Copy Markdown
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.

Looks correct to me. Thanks for catching this!

@ericof ericof self-requested a review September 21, 2023 22:23
@ericof ericof added this to the 2.4.0 milestone Sep 21, 2023
@ericof ericof added the documentation This issue/PR relates to or includes documentation. label Sep 21, 2023
@ericof ericof merged commit f89e19e into cookiecutter:main Sep 21, 2023
@tvoirand tvoirand deleted the typo-in-tutorial branch September 25, 2023 08:03
@paulschwenn
Copy link
Copy Markdown

paulschwenn commented Dec 19, 2023

Looks like this has reverted.
The pushd command is missing the parent directory symbol again pushd ..
https://cookiecutter.readthedocs.io/en/latest/tutorials/tutorial2.html

@kurtmckee
Copy link
Copy Markdown
Member

This didn't revert -- it never actually got updated. Read the Docs is configured to track master, not main.

@audreyfeldroy @pydanny @ericof @jensens please modify cookiecutter's config in Read the Docs so that "latest" tracks main.

@pydanny
Copy link
Copy Markdown
Member

pydanny commented Dec 19, 2023

I've set RTD to target main and ran the build again. Can someone let me know if the change worked?

@audreyfeldroy
Copy link
Copy Markdown
Member

@kurtmckee
Copy link
Copy Markdown
Member

Thank you both! 👍

@kurtmckee
Copy link
Copy Markdown
Member

And happy holidays!

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.

6 participants