#21708 closed Uncategorized (fixed)
Documentation makes two distinct points but implies conjunction
Reported by: | Owned by: | nobody | |
---|---|---|---|
Component: | Documentation | Version: | 1.6 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
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.
In 270f7e21676f043464e9a3e252fec0a63e3c0b2a: