#21023 closed Cleanup/optimization (invalid)
Your documentation is poor at best.
Reported by: | Owned by: | nobody | |
---|---|---|---|
Component: | Documentation | Version: | 1.5 |
Severity: | Normal | Keywords: | URL |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description (last modified by )
Here is how you do it:
URLS:
from django.conf.urls import patterns, url urlpatterns = patterns('', url(r'^articles/(\d{4})/$', 'news.views.year_archive'), url(r'^articles/(\d{4})/(\d{2})/$', 'news.views.month_archive'), url(r'^articles/(\d{4})/(\d{2})/(\d+)/$', 'news.views.article_detail'), )
You go line by line and say r = raw. This means no escape characters, the compiler processes what it sees.
Next: ^
from Regular expressions means the beginning of the line beginning with the word articles?
The slash is:
Then you put parenthesis because?: GET IT?
then there is another slash
AND SO ON!!!! ONE STEP at a time
THIS IS HOW YOU EXPLAIN THINGS. Make believe the person reading it doesnt know anything about Regular expressions. These are not standard Regex.. not like Perl
Change History (5)
comment:1 by , 11 years ago
comment:2 by , 11 years ago
Type: | Uncategorized → Cleanup/optimization |
---|
comment:3 by , 11 years ago
Resolution: | → invalid |
---|---|
Status: | new → closed |
comment:4 by , 11 years ago
Description: | modified (diff) |
---|
comment:5 by , 11 years ago
Can we trade a lesson of "how to report a ticket without pissing off maintainers" against a lesson of "how to explain things in technical documentation"? ;-)
The tutorial aims to strike a balance between newbie developers and new to django developers. It is explicitly not a *python* tutorial, and a detailed analysis of the structure of a python regex is not helpful in this context.
The current version of the docs has a number of links for understanding regexes better already. https://docs.djangoproject.com/en/1.5/intro/tutorial03/#url-argument-regex