add query strings to docs/user/tutorial #2239
Conversation
docs/user/tutorial.rst
Outdated
| images = self._image_store.list(max_size) | ||
| doc = { | ||
| 'images': [ | ||
| {'href': '/images/'+image} for image in images |
There was a problem hiding this comment.
| {'href': '/images/'+image} for image in images | |
| {'href': '/images/' + image} for image in images |
| def __init__(self, image_store): | ||
| self._image_store = image_store | ||
|
|
||
| def on_get(self, req, resp): |
There was a problem hiding this comment.
This version should be a static one like the above that serializes to msgpack, since we refer to it as "static"
There was a problem hiding this comment.
My bad 🥲 . You're totally right.
docs/user/tutorial.rst
Outdated
| images = self._image_store.list(max_size) | ||
| doc = { | ||
| 'images': [ | ||
| {'href': '/images/'+image} for image in images |
There was a problem hiding this comment.
| {'href': '/images/'+image} for image in images | |
| {'href': '/images/' + image} for image in images |
docs/user/tutorial.rst
Outdated
| ] | ||
| return images | ||
|
|
||
| As you can see the method ``list`` has been added to ``ImageStore`` in order to return list of available images smaller than ``max_size`` unless it is not zero, in which case it will behave like there was no predicament of image size. |
There was a problem hiding this comment.
maybe we could use -1 for the "defaut" here?
docs/user/tutorial.rst
Outdated
| return images | ||
|
|
||
| As you can see the method ``list`` has been added to ``ImageStore`` in order to return list of available images smaller than ``max_size`` unless it is not zero, in which case it will behave like there was no predicament of image size. | ||
| Let's try to save some binary data as images in the service and then try to retrieve their list. Execute the following commands in order to make 3 files as images with different sizes. |
There was a problem hiding this comment.
since these are not really images, we could use "images" here and maybe say something like
Execute the following commands in order to simulate the creation of 3 files as images with different sizes. While these are not valid PNG files, they will work for this tutorial.
docs/user/tutorial.rst
Outdated
| self._image_store = image_store | ||
|
|
||
| def on_get(self, req, resp): | ||
| max_size = int(req.params.get("maxsize", 0)) |
There was a problem hiding this comment.
I think it would be useful to showcase get_param_as_int here, so we could do
| max_size = int(req.params.get("maxsize", 0)) | |
| max_size = int(req.get_param_as_int("maxsize", default=0, min_value=1)) |
(I've added a min value but we may omit it too)
|
I have a question regarding a part of the code. which I used from previous parts of the docs. However, I didn't try to fix it here and I thought that maybe I should first report it as an issue and then resolve it in another PR. Am I right or should I try the fix on this PR since it's a small change? |
Summary of Changes
Fill in the placeholder for
Query Stringsin the documentation. The placeholder only existed on WSGI tutorial, so the proposed change is just about that part of the documentation.Related Issues
#475
Pull Request Checklist
This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!
If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.
docs/.docs/.versionadded,versionchanged, ordeprecateddirectives.docs/_newsfragments/, with the file name format{issue_number}.{fragment_type}.rst. (Runtowncrier --draftto ensure it renders correctly.)If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!
PR template inspired by the attrs project.