Opened 18 months ago

Closed 14 months ago

Last modified 14 months ago

#21938 closed Cleanup/optimization (fixed)

Improve docs/ref/views.txt

Reported by: timo Owned by: JLinden
Component: Documentation Version: 1.6
Severity: Normal Keywords: afraid-to-commit
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

As noted in this PR, the "Built-in views" page isn't very useful. We should expand this page into a proper reference guide for the functions in django.views, probably moving some content from topics/http/views.txt.

Change History (8)

comment:1 Changed 18 months ago by oswalpalash@…

I totally Agree to your point. For new users view's functions need to be defined more practically for usage. I'm a newbie here, but I'd like to contribute to this fix. I'd be glad to help out and write the documentation part.

comment:2 Changed 15 months ago by EvilDMP

  • Keywords afraid-to-commit added

Ear-marked as suitable for a first-time committer at DjangoCon Europe 2014.

comment:3 Changed 15 months ago by JLinden

  • Owner changed from nobody to JLinden
  • Status changed from new to assigned

comment:4 Changed 15 months ago by JLinden

The error views are currently ordered by most commonly used, should we keep it that way or order them by status code instead? As in 400, 403, 404, 500.

comment:5 Changed 15 months ago by timo

I think the current order is okay, but I don't feel strongly about it. We are likely to replace them with something more generic anyway (see #22058).

comment:6 Changed 15 months ago by JLinden

Ok, the order stays as it is.

I've sent a PR with my changes at https://github.com/django/django/pull/2710

Most of the changes just involed moving paragraphs to ref and rephrasing them a bit.

Last edited 15 months ago by JLinden (previous) (diff)

comment:7 Changed 14 months ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from assigned to closed

In 5b98ba08e2cc8760525fc1e0a2c917c063b0d5e2:

Fixed #21938 -- Moved documentation for error views to reference guide.

comment:8 Changed 14 months ago by Tim Graham <timograham@…>

In a83c56a45a976375ffe1bdf014b0f1c38a610ee6:

[1.7.x] Fixed #21938 -- Moved documentation for error views to reference guide.

Backport of 5b98ba08e2cc8760525fc1e0a2c917c063b0d5e2 from master

Note: See TracTickets for help on using tickets.
Back to Top