Browse Source

Grammatical adjustments of advanced topic `images`, to resolve issue #9407 (#9408)

Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
Damilola Oladele 2 years ago
parent
commit
de28bca258

+ 1 - 1
docs/advanced_topics/images/feature_detection.md

@@ -90,7 +90,7 @@ For example, in an app's [AppConfig.ready](https://docs.djangoproject.com/en/2.2
 
 The face detection algorithm produces a focal area that is tightly cropped to the face rather than the whole head.
 
-For images with a single face this can be okay in some cases (thumbnails for example), it might be overly tight for "headshots".
+For images with a single face, this can be okay in some cases (thumbnails for example), however, it might be overly tight for "headshots".
 Image renditions can encompass more of the head by reducing the crop percentage (`-c<percentage>`), at the end of the resize-rule, down to as low as 0%:
 
 ```html+django

+ 1 - 1
docs/advanced_topics/images/image_file_formats.md

@@ -28,7 +28,7 @@ By default all `bmp` and `webp` images are converted to the `png` format
 when no image output format is given.
 
 The default conversion mapping can be changed by setting the
-`WAGTAILIMAGES_FORMAT_CONVERSIONS` to a dictionary which maps the input type
+`WAGTAILIMAGES_FORMAT_CONVERSIONS` to a dictionary, which maps the input type
 to an output type.
 
 For example:

+ 3 - 3
docs/advanced_topics/images/image_serve_view.md

@@ -8,7 +8,7 @@ method. See [](image_renditions).
 If you need to be able to generate image versions for an _external_ system such as a blog or mobile app,
 Wagtail provides a view for dynamically generating renditions of images by calling a unique URL.
 
-The view takes an image id, filter spec and security signature in the URL. If
+The view takes an image id, filter spec, and security signature in the URL. If
 these parameters are valid, it serves an image file matching that criteria.
 
 Like the `{% image %}` tag, the rendition is generated on the first call and
@@ -100,7 +100,7 @@ You can pass an optional view name that will be used to serve the image through.
 ### Making the view redirect instead of serve
 
 By default, the view will serve the image file directly. This behaviour can be
-changed to a 301 redirect instead which may be useful if you host your images
+changed to a 301 redirect instead, which may be useful if you host your images
 externally.
 
 To enable this, pass `action='redirect'` into the `ServeView.as_view()`
@@ -125,7 +125,7 @@ server instead of serving it directly from the Django application. This could
 greatly reduce server load in situations where your site has many images being
 downloaded but you're unable to use a [](caching_proxy) or a CDN.
 
-You firstly need to install and configure django-sendfile and configure your
+You first need to install and configure django-sendfile and configure your
 web server to use it. If you haven't done this already, please refer to the
 [installation docs](https://github.com/johnsensible/django-sendfile#django-sendfile).
 

+ 3 - 3
docs/advanced_topics/images/renditions.md

@@ -16,7 +16,7 @@ If `myimage` had a filename of `foo.jpg`, a new rendition of the image file call
 Argument options are identical to the `{% image %}` template tag's filter spec, and should be separated with `|`.
 
 The generated `Rendition` object will have properties specific to that version of the image, such as
-`url`, `width` and `height`, so something like this could be used in an API generator, for example:
+`url`, `width` and `height`. Hence, something like this could be used in an API generator, for example:
 
 ```python
 url = myimage.get_rendition('fill-300x186|jpegquality-60').url
@@ -48,7 +48,7 @@ The `prefetch_renditions` method is only applicable in Wagtail versions 4.0 and
 
 When working with an Image QuerySet, you can make use of Wagtail's built-in `prefetch_renditions` queryset method to prefetch the renditions needed.
 
-For example, say you were rendering a list of all the images uploaded by a certain user:
+For example, say you were rendering a list of all the images uploaded by a user:
 
 ```python
 def get_images_uploaded_by_user(user):
@@ -119,7 +119,7 @@ def get_events():
 The following method references are only applicable to Wagtail versions 3.0 and above.
 ```
 
-The following `AbstractImage` model methods are involved in finding and generating a renditions. If using a custom image model, you can customise the behaviour of either of these methods by overriding them on your model:
+The following `AbstractImage` model methods are involved in finding and generating renditions. If using a custom image model, you can customise the behaviour of either of these methods by overriding them on your model:
 
 ```{eval-rst}
 .. automodule:: wagtail.images.models

+ 1 - 1
docs/advanced_topics/images/title_generation_on_upload.md

@@ -57,7 +57,7 @@ def get_global_admin_js():
 
 ### Changing generated titles on the page editor only to remove dashes/underscores
 
-Using the [`insert_editor_js` hook](insert_editor_js) instead so that this script will not run on the `Image` upload page, only on page editors.
+Use the [`insert_editor_js` hook](insert_editor_js) instead so that this script will not run on the `Image` upload page, only on page editors.
 
 ```python
 # wagtail_hooks.py