[Django] #29646: URL Schemes missing from documentation in URField

5 views
Skip to first unread message

Django

unread,
Aug 7, 2018, 6:07:17 AM8/7/18
to django-...@googlegroups.com
#29646: URL Schemes missing from documentation in URField
------------------------------------------------+------------------------
Reporter: shreybatra | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 2.1
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
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.

--
Ticket URL: <https://code.djangoproject.com/ticket/29646>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Aug 7, 2018, 6:28:56 AM8/7/18
to django-...@googlegroups.com
#29646: URL Schemes missing from documentation in URField
-------------------------------------+-------------------------------------
Reporter: shreybatra | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:

Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson):

This is mentioned in the
[https://docs.djangoproject.com/en/2.1/ref/validators/#urlvalidator
URLValidator docs].

--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:1>

Django

unread,
Aug 7, 2018, 4:00:22 PM8/7/18
to django-...@googlegroups.com
#29646: URL Schemes missing from documentation in URField
-------------------------------------+-------------------------------------
Reporter: shreybatra | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:

Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Josh Schneier):

EmailField mentions it uses EmailValidator, probably all fields should
mention (link to) their default validators in some way.

--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:2>

Django

unread,
Aug 7, 2018, 4:09:20 PM8/7/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
--------------------------------------+------------------------------------

Reporter: shreybatra | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham):

* stage: Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:3>

Django

unread,
Aug 11, 2018, 12:27:24 PM8/11/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
--------------------------------------+------------------------------------
Reporter: Shrey Batra | Owner: Jeff
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Jeff):

* owner: nobody => Jeff
* status: new => assigned


--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:4>

Django

unread,
Aug 15, 2018, 3:47:58 PM8/15/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
--------------------------------------+------------------------------------
Reporter: Shrey Batra | Owner: Jeff
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham):

* needs_better_patch: 0 => 1
* has_patch: 0 => 1


Comment:

[https://github.com/django/django/pull/10286 PR] (which documents only the
form field side so far)

--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:5>

Django

unread,
Aug 15, 2018, 3:50:52 PM8/15/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
--------------------------------------+------------------------------------
Reporter: Shrey Batra | Owner: Jeff
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by Jeff):

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.

--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:6>

Django

unread,
Aug 15, 2018, 4:08:02 PM8/15/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
--------------------------------------+------------------------------------
Reporter: Shrey Batra | Owner: Jeff
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham):

* needs_better_patch: 1 => 0


Comment:

I missed that apparently.

--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:7>

Django

unread,
Aug 15, 2018, 4:08:46 PM8/15/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
--------------------------------------+------------------------------------
Reporter: Shrey Batra | Owner: Jeff
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by Jeff):

Oh good, I was going a little mad trying to track down the relevant files,
haha.

--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:8>

Django

unread,
Aug 16, 2018, 4:13:22 AM8/16/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
-------------------------------------+-------------------------------------

Reporter: Shrey Batra | Owner: Jeff
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):

* stage: Accepted => Ready for checkin


--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:9>

Django

unread,
Aug 16, 2018, 5:03:49 PM8/16/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
-------------------------------------+-------------------------------------
Reporter: Shrey Batra | Owner: Jeff
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 2.1
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Tim Graham <timograham@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"3fa3de54152a6b7a67de05ff4ff6fb122c9246e2" 3fa3de5]:
{{{
#!CommitTicketReference repository=""
revision="3fa3de54152a6b7a67de05ff4ff6fb122c9246e2"
Fixed #29646 -- Doc'd the validators that each model and form field uses.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:10>

Django

unread,
Aug 16, 2018, 5:05:38 PM8/16/18
to django-...@googlegroups.com
#29646: Document the validators that each model and form field uses
-------------------------------------+-------------------------------------
Reporter: Shrey Batra | Owner: Jeff
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 2.1

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Tim Graham <timograham@…>):

In [changeset:"91af869d701c7f7f34a8aed834791bf5c9fb3d07" 91af869d]:
{{{
#!CommitTicketReference repository=""
revision="91af869d701c7f7f34a8aed834791bf5c9fb3d07"
[2.1.x] Fixed #29646 -- Doc'd the validators that each model and form
field uses.

Backport of 3fa3de54152a6b7a67de05ff4ff6fb122c9246e2 from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/29646#comment:11>

Reply all
Reply to author
Forward
0 new messages