#29646 closed Cleanup/optimization (fixed)
Document the validators that each model and form field uses
| Reported by: | Shrey Batra | Owned by: | Jeff |
|---|---|---|---|
| Component: | Documentation | Version: | 2.1 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
URL schemes are missing in the documentation of URLField. SHould be added that only http, https, ftp and ftps are valid. others are not valid.
Change History (11)
comment:1 by , 6 years ago
comment:2 by , 6 years ago
EmailField mentions it uses EmailValidator, probably all fields should mention (link to) their default validators in some way.
comment:3 by , 6 years ago
| Summary: | URL Schemes missing from documentation in URField → Document the validators that each model and form field uses |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
comment:4 by , 6 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:5 by , 6 years ago
| Has patch: | set |
|---|---|
| Patch needs improvement: | set |
PR (which documents only the form field side so far)
comment:6 by , 6 years ago
Hmm, I thought docs/ref/models/fields.txt, contained the documentation of model fields (which is in the PR as well). I will look through the docs more thoroughly to see if there are more files that contain model fields for documentation.
comment:8 by , 6 years ago
Oh good, I was going a little mad trying to track down the relevant files, haha.
comment:9 by , 6 years ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
Note:
See TracTickets
for help on using tickets.
This is mentioned in the URLValidator docs.