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

Fixed #1509 -- Added clear documentation in tutorial 1 docs to avoid confusion #18174

Closed
wants to merge 1 commit into from

Conversation

nandanak
Copy link

@nandanak nandanak commented May 16, 2024

Modified the tutorial 1 documentation on the polls app. (django#1509)

There was a possibility of confusion to occur that the user might create a new "urls.py" file in the root "mysite" directory instead of adding code into the existing "urls.py" file inside the inner "mysite" directory, in the sentence

The next step is to point the root URLconf at the polls.urls module. In mysite/urls.py, add an import for django.urls.include and insert an include() in the urlpatterns list, so you have...

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hello! Thank you for your contribution 💪

As it's your first contribution be sure to check out the patch review checklist.

If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket!

If you have any design or process questions then you can ask in the Django forum.

Welcome aboard ⛵️!

@sarahboyce
Copy link
Contributor

Thank you @nandanak, I find the docs already quite clear and I would want to hear that a beginner actually found it confusing instead of "this is possibly confusing" before considering making an update 👍

@sarahboyce sarahboyce closed this May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants