Fixed #21938 -- Restructured documentation for built-in views #2710

Closed
wants to merge 2 commits into
from

Conversation

Projects
None yet
2 participants
Contributor

JoLinden commented May 24, 2014

Moved the reference for built-in error views to the correct
documentation page. Restructured the remaining information on
customizing error views in a less repetitive way.

docs/ref/views.txt
+
+.. _http_not_found_view:
+
+Django comes with a few views by default for handling HTTP errors. To override these with your own custom views, see :ref:`customizing-error-views`.
@timgraham

timgraham May 25, 2014

Owner

please wrap lines at 80 characters

docs/ref/views.txt
+.. _error-views:
+
+Error views
+=======================
@timgraham

timgraham May 25, 2014

Owner

underline should be same length as text

docs/ref/views.txt
+Django comes with a few views by default for handling HTTP errors. To override these with your own custom views, see :ref:`customizing-error-views`.
+
+The 404 (page not found) view
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@timgraham

timgraham May 25, 2014

Owner

Let's use ----- for second level underline, I think that's what's use most often elsewhere in the docs.

docs/ref/views.txt
+Error views
+=======================
+
+.. _http_not_found_view:
@timgraham

timgraham May 25, 2014

Owner

this anchor needs to be below the paragraph below and above the heading (try building the docs to make sure there are no errors)

docs/topics/http/views.txt
-``bad_request`` views are also only used when :setting:`DEBUG` is ``False``.
+ handler400 = 'mysite.views.my_custom_bad_request_view'
@timgraham

timgraham May 25, 2014

Owner

Don't remove the newline on the last line (shouldn't be that "No newline at end of file" symbol in the gihub diff)

Owner

timgraham commented May 25, 2014

Please note our commit message guidelines (include ticket number like so: "Fixed #XXXXX --"). Also a more descriptive message would be helpful. "Improved" is rather vague. :-) Thanks for working on this.

@JoLinden JoLinden changed the title from Improved docs/ref/views.txt and docs/topics/http/views.txt to Fixed #21938 -- Restructured documentation for built-in views Jun 1, 2014

Contributor

JoLinden commented Jun 1, 2014

I've updated the PR based on your review, and also edited the commit message to what I think is according to the guidelines.

Thanks for the detailed feedback! It helps a lot as a first time contributor. :)

Owner

timgraham commented Jun 1, 2014

merged in 5b98ba0, thanks.

@timgraham timgraham closed this Jun 1, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment