Opened 14 months ago

Closed 14 months ago

Last modified 14 months ago

#21708 closed Uncategorized (fixed)

Documentation makes two distinct points but implies conjunction

Reported by: ashley@… Owned by: nobody
Component: Documentation Version: 1.6
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation:
Needs tests: Patch needs improvement:
Easy pickings: yes UI/UX: no

Description

As a django newbie I was confused by the following section:

https://docs.djangoproject.com/en/1.6/topics/http/urls/#notes-on-capturing-text-in-urls

The first section talks about the difference between URL matching types and the types passed as view arguments, the latter being only strings.

This is followed by what I thought was a conjunction "A convenient trick is to...", implying a solution to the type disparity described above.

Interpreted thus, the next section implies that setting a default parameter will cause an implicit type conversion to occur.

In fact, the next section simply talks about a completely separate point, namely using a parameterised function for a non-parameterised url.

Perhaps I'm just splitting hairs here, but I think the documentation would be improved if these two different notes were delineated in the documentation. Perhaps via bullet points.

Change History (3)

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

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

In 270f7e21676f043464e9a3e252fec0a63e3c0b2a:

Fixed #21708 -- Added some headings to separate unrelated topics.

Thanks ashley at ashleymills.com for the suggestion.

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

In f20da282972628daed1d792104500600d233d897:

[1.5.x] Fixed #21708 -- Added some headings to separate unrelated topics.

Thanks ashley at ashleymills.com for the suggestion.

Backport of 270f7e2167 from master

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

In 2d554d29f2f3b495768e4100e9b48c1bb6242799:

[1.6.x] Fixed #21708 -- Added some headings to separate unrelated topics.

Thanks ashley at ashleymills.com for the suggestion.

Backport of 270f7e2167 from master

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