Skip to content

Commit

Permalink
minor documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
jugmac00 committed Apr 7, 2021
1 parent 710f746 commit 94cd1e4
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,14 @@ data. To limit the max upload size, you can use Flask's `MAX_CONTENT_LENGTH`.

Upload Sets
===========
An "upload set" is a single collection of files. You just declare them in the
code::
An `UploadSet` is a single collection of files.
You just declare them in the code::

photos = UploadSet('photos', IMAGES)

And then you can use the `~UploadSet.save` method to save uploaded files and
`~UploadSet.path` and `~UploadSet.url` to access them. For example::
And then you can use the `UploadSet.save` method to save uploaded files and
`UploadSet.path` and `UploadSet.url` to access them.
For example::

@app.route('/upload', methods=['GET', 'POST'])
def upload():
Expand Down Expand Up @@ -154,10 +155,10 @@ though. It's just to save your users a little configuration time.

App Configuration
=================
An upload set's configuration is stored on an app. That way, you can have
An `UploadSet`'s configuration is stored on an app. That way, you can have
upload sets being used by multiple apps at once. You use the
`configure_uploads` function to load the configuration for the upload sets.
You pass in the app and all of the upload sets you want configured. Calling
`configure_uploads` function to load the configuration for the `UploadSet`s.
You pass in the app and all of the `UploadSet`s you want configured. Calling
`configure_uploads` more than once is safe. ::

configure_uploads(app, (photos, media))
Expand Down

0 comments on commit 94cd1e4

Please sign in to comment.