Skip to content

Tweaked a few issues in the tutorial documentation. #2397

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

Merged
merged 1 commit into from
Jan 10, 2015

Conversation

travelton
Copy link
Contributor

  1. Adjusted the verbiage in part 1, to replace the class with the code snippet.
  2. Removed an unused import in code sample of urls.py in part 3.
  3. Clarified SnippetDetail view class in part 4.
  4. Added a missing import in part 5.

@tomchristie
Copy link
Member

All seems reasonable to me. Anyone else want to review too and commit if you're happy?

@@ -106,6 +106,8 @@ If we're going to have a hyperlinked API, we need to make sure we name our URL p

After adding all those names into our URLconf, our final `snippets/urls.py` file should look something like this:

from django.conf.urls import url, include
Copy link
Member

Choose a reason for hiding this comment

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

I think here we should be adding all imports since we are saying "this is how it should be looking"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tend to agree... If that's the case, a few other samples show a diff, versus all imports. While I was going through the samples, I would copy/paste and review in my text editor. So it was difficult when diffs were provided. Anyone else have opinions?

@tomchristie
Copy link
Member

I'm not totally convinced one way or the other. It does add noise, but get your point. Not fussed about this one, but not sure I'd want to see it repeated everywhere.

@jpadilla
Copy link
Member

@tomchristie yeah I get it. Tutorial isn't meant to be taken out of context I guess, It has continuity from the first one till the last one. I'm ok merging this as is.

tomchristie added a commit that referenced this pull request Jan 10, 2015
Tweaked a few issues in the tutorial documentation.
@tomchristie tomchristie merged commit 605c1fa into encode:master Jan 10, 2015
@tomchristie
Copy link
Member

Thanks @travelton!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants