Browse Source

Fix minor whitespace formatting issues in docs

LB 2 months ago
parent
commit
0bf909414a

+ 1 - 1
docs/advanced_topics/accessibility_considerations.md

@@ -20,7 +20,7 @@ As part of defining your site’s models, here are areas to pay special attentio
 
 ### Alt text for images
 
-Wherever an image is used, the content editor should be able to mark the image as decorative or provide a context-specific text alternative. The image embed in our rich text editor supports this behavior.  Wagtail 6.3 added [`ImageBlock`](streamfield_imageblock) to provide this behavior for images within StreamFields.
+Wherever an image is used, the content editor should be able to mark the image as decorative or provide a context-specific text alternative. The image embed in our rich text editor supports this behavior. Wagtail 6.3 added [`ImageBlock`](streamfield_imageblock) to provide this behavior for images within StreamFields.
 
 Wagtail 6.3 also added an optional `description` field to the Wagtail image model and to custom image models inheriting from `wagtail.images.models.AbstractImage`. Text in that field will be offered as the default alt text when inserting images in rich text or using ImageBlock. If the description field is empty, the title field will be used instead. If you would like to customize this behavior, [override the `default_alt_text` property](custom_image_model) in your image model.
 

+ 9 - 3
docs/getting_started/tutorial.md

@@ -38,7 +38,9 @@ This tutorial uses [`venv`](inv:python#tutorial/venv), which is packaged with Py
 ```doscon
 py -m venv mysite\env
 ```
+
 Activate this virtual environment using:
+
 ```doscon
 mysite\env\Scripts\activate.bat
 
@@ -49,14 +51,18 @@ mysite\env\Scripts\activate
 
 **On GNU/Linux or MacOS** (bash):
 
-Create the virtual environment using:  
+Create the virtual environment using:
+
 ```sh
 python -m venv mysite/env
 ```
+
 Activate the virtual environment using:
+
 ```sh
 source mysite/env/bin/activate
 ```
+
 Upon activation, your command line will show `(env)` to indicate that you're now working within this virtual environment.
 
 **For other shells** see the [`venv` documentation](inv:python#tutorial/venv).
@@ -566,7 +572,7 @@ class BlogPage(Page):
 
         # Add this
          "gallery_images",
-        ] 
+        ]
 
 
 class BlogPageGalleryImage(Orderable):
@@ -737,7 +743,7 @@ class BlogPage(Page):
     ]
 ```
 
-Here you have used the  `MultiFieldPanel` in `content_panels` to group  the `date` and `authors` fields together for readability. By doing this, you are creating a single panel object that encapsulates multiple fields within a list or tuple into a single `heading` string. This feature is particularly useful for organizing related fields in the admin interface, making the UI more intuitive for content editors.
+Here you have used the  `MultiFieldPanel` in `content_panels` to group the `date` and `authors` fields together for readability. By doing this, you are creating a single panel object that encapsulates multiple fields within a list or tuple into a single `heading` string. This feature is particularly useful for organizing related fields in the admin interface, making the UI more intuitive for content editors.
 
 Migrate your database by running `python manage.py makemigrations` and `python manage.py migrate`, and then go to your [admin interface](https://guide.wagtail.org/en-latest/concepts/wagtail-interfaces/#admin-interface) . Notice that the list of authors is presented as a multiple select box. This is the default representation for a multiple choice field - however, users often find a set of checkboxes to be more familiar and easier to work with.
 

+ 10 - 8
docs/reference/hooks.md

@@ -1178,16 +1178,18 @@ def add_custom_headers(next_serve_page):
 ```
 
 Parameters passed to the function:
-- `page` - the Page object being served
-- `request` - the request object
-- `args` - positional arguments that will be passed to the page's serve method
-- `kwargs` - keyword arguments that will be passed to the page's serve method
+
+-   `page` - the Page object being served
+-   `request` - the request object
+-   `args` - positional arguments that will be passed to the page's serve method
+-   `kwargs` - keyword arguments that will be passed to the page's serve method
 
 This hook is particularly useful for:
-- Adding/modifying response headers
-- Implementing access restrictions
-- Modifying the response content
-- Adding logging or monitoring
+
+-   Adding/modifying response headers
+-   Implementing access restrictions
+-   Modifying the response content
+-   Adding logging or monitoring
 
 ## Document serving
 

+ 0 - 1
docs/reference/panels.md

@@ -71,7 +71,6 @@ Instead of
 ```
 ````
 
-
 (multiFieldPanel)=
 
 ### MultiFieldPanel

+ 0 - 1
docs/releases/6.3.3.md

@@ -11,7 +11,6 @@ depth: 1
 
 ## What's new
 
-
 ### Bug fixes
 
  * Correctly place comment buttons next to date / datetime / time fields. (Srishti Jaiswal)