Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#19239 closed Cleanup/optimization (fixed)

Provide examples in the ref docs for Generic date views

Reported by: pydanny Owned by: pydanny
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: citadelgrad, timograham@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description

The reference docs need codes examples as done in https://docs.djangoproject.com/en/dev/ref/class-based-views/base/.

This makes the reference documentation much easier to use, and makes them a place for canonical examples of how things should or could be done.

Change History (8)

comment:1 Changed 3 years ago by pydanny

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

I'm working this ticket with @scottnixon at https://github.com/citadelgrad/django/tree/ticket_19239. Should be ready to push for review in 1-2 days.

comment:2 Changed 3 years ago by ptone

  • Component changed from Uncategorized to Documentation
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Cleanup/optimization
  • Version changed from 1.4 to master

comment:3 Changed 3 years ago by pydanny

Submitted pull request for this ticket at https://github.com/django/django/pull/517.

Work performed with @citadelgrad / Scott Nixon of https://github.com/citadelgrad.

comment:4 Changed 3 years ago by timo

  • Has patch set

comment:5 Changed 3 years ago by timo

  • Cc timograham@… added
  • Patch needs improvement set

Waiting on Danny to update the original pull request based on feedback.

comment:6 Changed 3 years ago by pydanny

Just updated pull request https://github.com/django/django/pull/517, which meant fixing a bad merge and then incorporating @timo's requests.

The work is in https://github.com/citadelgrad/django/commit/45350359921a325036390e46afc10f53488e360c.

Thanks @timo and @citadelgrad!

comment:7 Changed 3 years ago by Tim Graham <timograham@…>

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

In 38055222bd4f56bac6ae0f7a53c07bf924967daf:

Fixed #19239 - Added examples for generic date views

Thank-you Daniel Greenfeld and Scott Nixon.

comment:8 Changed 3 years ago by Tim Graham <timograham@…>

In ecf292aa2c89935bbc243d29ead3e01f1380e246:

[1.5.X] Fixed #19239 - Added examples for generic date views

Thank-you Daniel Greenfeld and Scott Nixon.

Backport of 38055222bd from master

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