Skip to content

Commit 9e1a257

Browse files
mattmakaimattmakai
committed
update descriptions on django and flask examples pages to make them more helpful
1 parent 314c2ba commit 9e1a257

34 files changed

+70
-38
lines changed

‎content/pages/examples/django/django-contrib-admin-helpers-actionform.markdown‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: django.contrib.admin.helpers ActionForm code examples
1+
title: django.contrib.admin.helpers ActionForm Example Code
22
category: page
33
slug: django-contrib-admin-helpers-actionform-examples
44
sortorder: 500011020
@@ -7,7 +7,13 @@ sidebartitle: django.contrib.admin.helpers ActionForm
77
meta: Python example code for the ActionForm class from the django.contrib.admin.helpers module of the Django project.
88

99

10-
ActionForm is a class within the django.contrib.admin.helpers module of the Django project.
10+
[ActionForm](https://github.com/django/django/blob/master/django/contrib/admin/helpers.py)
11+
is a class within the django.contrib.admin.helpers module of the
12+
[Django](/django.html) project. It is not typically used when creating
13+
applications but is sometimes used by libraries that want to extend the
14+
[actions available](https://docs.djangoproject.com/en/stable/ref/contrib/admin/actions/)
15+
within the
16+
[Django Admin](https://docs.djangoproject.com/en/stable/ref/contrib/admin/).
1117

1218

1319
## Example 1 from django-import-export

‎content/pages/examples/django/django-contrib-admin-helpers-adminform.markdown‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: django.contrib.admin.helpers AdminForm code examples
1+
title: django.contrib.admin.helpers AdminForm Example Code
22
category: page
33
slug: django-contrib-admin-helpers-adminform-examples
44
sortorder: 500011021
@@ -7,7 +7,13 @@ sidebartitle: django.contrib.admin.helpers AdminForm
77
meta: Python example code for the AdminForm class from the django.contrib.admin.helpers module of the Django project.
88

99

10-
AdminForm is a class within the django.contrib.admin.helpers module of the Django project.
10+
[AdminForm](https://github.com/django/django/blob/master/django/contrib/admin/helpers.py)
11+
is a class within the django.contrib.admin.helpers module of the
12+
[Django](/django.html) project. AdminForm is not usually used directly by
13+
developers but can be used by libraries that want to extend the
14+
[forms](https://docs.djangoproject.com/en/3.0/ref/contrib/admin/admindocs/)
15+
within the
16+
[Django Admin](https://docs.djangoproject.com/en/stable/ref/contrib/admin/).
1117

1218

1319
## Example 1 from django-cms

‎content/pages/examples/django/django-contrib-admin-helpers.markdown‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
title: django.contrib.admin helpers code examples
1+
title: django.contrib.admin helpers Example Code
22
category: page
33
slug: django-contrib-admin-helpers-examples
44
sortorder: 500011017
55
toc: False
66
sidebartitle: django.contrib.admin helpers
7-
meta: Python example code for the helpers function from the django.contrib.admin module of the Django project.
7+
meta: Python example code for the helpers callable from the django.contrib.admin module of the Django project.
88

99

10-
helpers is a function within the django.contrib.admin module of the Django project.
10+
[helpers](https://github.com/django/django/blob/master/django/contrib/admin/helpers.py)
11+
is a module within the [Django](/django.html) project code base. It
12+
contains classes related to extending the functionality of the
13+
[Django Admin](https://docs.djangoproject.com/en/3.0/ref/contrib/admin/actions/),
14+
such as [ActionForm](/django-contrib-admin-helpers-actionform-examples.html)
15+
and [AdminForm](/django-contrib-admin-helpers-adminform-examples.html).
1116

1217

1318
## Example 1 from django-filer

‎content/pages/examples/django/django-extensions-plug-ins.markdown‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,15 @@ django-loginas is open source under the
331331
[BSD 3-Clause "New" or "Revised" License](https://github.com/skorokithakis/django-loginas/blob/master/LICENSE).
332332

333333

334+
### django-markdown-view
335+
[django-markdown-view](https://github.com/rgs258/django-markdown-view)
336+
([PyPI package information](https://pypi.org/project/django-markdown-view/))
337+
is a Django extension for serving [Markdown](/markdown.html) files as
338+
[Django templates](/django-templates.html). The project is open
339+
sourced under the
340+
[BSD 3-Clause "New" or "Revised" license](https://github.com/rgs258/django-markdown-view/blob/master/LICENSE).
341+
342+
334343
### django-migration-linter
335344
[django-migration-linter](https://github.com/3YOURMIND/django-migration-linter)
336345
([PyPI package information](https://pypi.org/project/django-migration-linter/))

‎content/pages/examples/flask/flask-app-badrequest.markdown‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: flask.app BadRequest code examples
1+
title: flask.app BadRequest Example Code
22
category: page
33
slug: flask-app-badrequest-examples
44
sortorder: 500021000
@@ -7,7 +7,13 @@ sidebartitle: flask.app BadRequest
77
meta: Python example code for the BadRequest class from the flask.app module of the Flask project.
88

99

10-
BadRequest is a class within the flask.app module of the Flask project.
10+
[BadRequest](https://github.com/pallets/flask/blob/master/src/flask/app.py)
11+
is an [Exception](https://docs.python.org/3/library/exceptions.html#Exception)
12+
imported into the [Flask](/flask.html) [web framework](/web-frameworks.html)
13+
from the [Werkzeug](https://github.com/pallets/werkzeug) project. It can occur
14+
at runtime when an
15+
[invalid POST request is sent to a URL route](https://stackoverflow.com/questions/14105452/what-is-the-cause-of-the-bad-request-error-when-submitting-form-in-flask-applica)
16+
that accepts POSTs.
1117

1218

1319
## Example 1 from Flask AppBuilder

‎content/pages/examples/flask/flask-app-flask.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: flask.app Flask code examples
1+
title: flask.app Flask Example Code
22
category: page
33
slug: flask-app-flask-examples
44
sortorder: 500021001

‎content/pages/examples/flask/flask-app-headers.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: flask.app Headers code examples
1+
title: flask.app Headers Example Code
22
category: page
33
slug: flask-app-headers-examples
44
sortorder: 500021002

‎content/pages/examples/flask/flask-blueprints-blueprint.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: flask.blueprints Blueprint code examples
1+
title: flask.blueprints Blueprint Example Code
22
category: page
33
slug: flask-blueprints-blueprint-examples
44
sortorder: 500021003

‎content/pages/examples/flask/flask-cli-flaskgroup.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: flask.cli FlaskGroup code examples
1+
title: flask.cli FlaskGroup Example Code
22
category: page
33
slug: flask-cli-flaskgroup-examples
44
sortorder: 500021004

‎content/pages/examples/flask/flask-cli-scriptinfo.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: flask.cli ScriptInfo code examples
1+
title: flask.cli ScriptInfo Example Code
22
category: page
33
slug: flask-cli-scriptinfo-examples
44
sortorder: 500021005

0 commit comments

Comments
 (0)