Merge pull request #269 from alphagov/python-dates-fix

Make the date format in snippet match GDS content guide

Author: CrystalPea

source/documentation/client_docs/_python.md

@@ -84,15 +84,15 @@ If a template has placeholder fields for personalised information such as name o
 ```python
 personalisation={
     "first_name": "Amala",
-    "appointment_date": "2018-01-01 at 01:00PM",
+    "appointment_date": "1 January 2018 at 01:00PM",
 },
 ```
 
 You can leave out this argument if a template does not have any placeholder fields for personalised information.
 
 ##### reference (optional)
 
-A unique identifier you can create if necessary. This reference identifies a single unique message or a batch of messages. It must not contain any personal information such as name or postal address. For example:
+An identifier you can create if necessary. This reference identifies a single unique message or a batch of messages. It must not contain any personal information such as name or postal address. For example:
 
 ```python
 reference="your reference", # optional string - identifies notification(s)
@@ -129,7 +129,7 @@ If the request to the client is successful, the client returns a `dict`:
   "id": "740e5834-3a29-46b4-9a6f-16142fde533a",  # required string - notification ID
   "reference": "your reference", # optional string - reference you provided when sending the message
   "content": {
-    "body": "Hi Amala, your appointment is on 2018-01-01 at 01:00PM",  # required string - message content
+    "body": "Hi Amala, your appointment is on 1 January 2018 at 1:00pm",  # required string - message content
     "from_number": "GOVUK"  # required string - sender name / phone number
   },
   "uri": "https://api.notifications.service.gov.uk/v2/notifications/740e5834-3a29-46b4-9a6f-16142fde533a",  # required string
@@ -204,7 +204,7 @@ If a template has placeholder fields for personalised information such as name o
 ```python
 personalisation={
     "first_name": "Amala",
-    "appointment_date": "2018-01-01 at 01:00PM",
+    "appointment_date": "1 January 2018 at 1:00pm",
     # pass in a list and it will appear as bullet points in the message:
     "required_documents": ["passport", "utility bill", "other id"],
 },
@@ -213,7 +213,7 @@ You can leave out this argument if a template does not have any placeholder fiel
 
 ##### reference (optional)
 
-A unique identifier you can create if necessary. This reference identifies a single unique email or a batch of emails. It must not contain any personal information such as name or postal address. For example:
+An identifier you can create if necessary. This reference identifies a single unique email or a batch of emails. It must not contain any personal information such as name or postal address. For example:
 
 ```python
 reference="your reference", # optional string - identifies notification(s)
@@ -271,7 +271,7 @@ If the request to the client is successful, the client returns a `dict`:
   "reference": "your reference",  # optional string - reference you provided when sending the message
   "content": {
     "subject": "Your upcoming pigeon registration appointment",  # required string - message subject
-    "body": "Dear Amala\r\n\r\nYour pigeon registration appointment is scheduled for 2018-01-01 at 01:00PM.\r\n\r\nPlease bring:\r\n\n\n* passport\n* utility bill\n* other id\r\n\r\nYours,\r\nPigeon Affairs Bureau",  # required string - message content
+    "body": "Dear Amala\r\n\r\nYour pigeon registration appointment is scheduled for 1 January 2018 at 1:00pm.\r\n\r\nPlease bring:\r\n\n\n* passport\n* utility bill\n* other id\r\n\r\nYours,\r\nPigeon Affairs Bureau",  # required string - message content
     "from_email": "pigeon.affairs.bureau@notifications.service.gov.uk",  # required string - "FROM" email address, not a real inbox
     "one_click_unsubscribe_url": "https://example.com/unsubscribe.html?opaque=123456789",  # optional string
   },
@@ -335,7 +335,7 @@ with open("file.pdf", "rb") as f:
     ...
     personalisation={
       "first_name": "Amala",
-      "appointment_date": "2018-01-01 at 01:00PM",
+      "appointment_date": "1 January 2018 at 1:00pm",
       "link_to_file": prepare_upload(f),
     }
 ```
@@ -364,7 +364,7 @@ with open("file.csv", "rb") as f:
     ...
     personalisation={
       "first_name": "Amala",
-      "appointment_date": "2018-01-01 at 01:00PM",
+      "appointment_date": "1 January 2018 at 1:00pm",
       "link_to_file": prepare_upload(f, filename="amala_pigeon_affairs_bureau_invite.csv"),
     }
 ```
@@ -397,7 +397,7 @@ with open("file.pdf", "rb") as f:
     ...
     personalisation={
       "first_name": "Amala",
-      "appointment_date": "2018-01-01 at 01:00PM",
+      "appointment_date": "1 January 2018 at 1:00pm",
       "link_to_file": prepare_upload(f, confirm_email_before_download=False),
     }
 ```
@@ -424,7 +424,7 @@ with open("file.pdf", "rb") as f:
     ...
     personalisation={
       "first_name": "Amala",
-      "appointment_date": "2018-01-01 at 01:00PM",
+      "appointment_date": "1 January 2018 at 1:00pm",
       "link_to_file": prepare_upload(f, retention_period="4 weeks"),
     }
 ```
@@ -439,7 +439,7 @@ If the request to the client is successful, the client returns a `dict`:
   "reference": "your reference",  # optional string - reference you provided when sending the message
   "content": {
     "subject": "Your upcoming pigeon registration appointment",  # required string - message subject
-    "body": "Dear Amala\r\n\r\nYour pigeon registration appointment is scheduled for 2018-01-01 at 01:00PM.\r\n\r\n Here is a link to your invitation document:\r\nhttps://documents.service.gov.uk/d/YlxDzgNUQYi1Qg6QxIpptA/th46VnrvRxyVO9div6f7hA?key=R0VDmwJ1YzNYFJysAIjQd9yHn5qKUFg-nXHVe3Ioa3A\r\n\r\nPlease bring the invite with you to the appointment.\r\n\r\nYours,\r\nPigeon Affairs Bureau",  # required string - message content - see that the link to document is embedded in the message content
+    "body": "Dear Amala\r\n\r\nYour pigeon registration appointment is scheduled for 1 January 2018 at 1:00pm.\r\n\r\n Here is a link to your invitation document:\r\nhttps://documents.service.gov.uk/d/YlxDzgNUQYi1Qg6QxIpptA/th46VnrvRxyVO9div6f7hA?key=R0VDmwJ1YzNYFJysAIjQd9yHn5qKUFg-nXHVe3Ioa3A\r\n\r\nPlease bring the invite with you to the appointment.\r\n\r\nYours,\r\nPigeon Affairs Bureau",  # required string - message content - see that the link to document is embedded in the message content
     "from_email": "pigeon.affairs.bureau@notifications.service.gov.uk",  # required string - "FROM" email address, not a real inbox
     "one_click_unsubscribe_url": "https://example.com/unsubscribe.html?opaque=123456789",  # optional string
   },
@@ -545,15 +545,15 @@ personalisation={
   "address_line_4": "Middlesex",
   "address_line_5": "SW14 6BF",  # last line of address you include must be a postcode or a country name  outside the UK
   "name": "Amala",
-  "appointment_date": "2018-01-01 at 01:00PM",
+  "appointment_date": "1 January 2018 at 1:00pm",
   # pass in a list and it will appear as bullet points in the letter:
   "required_documents": ["passport", "utility bill", "other id"],
 }
 ```
 
 ##### reference (optional)
 
-A unique identifier you can create if necessary. This reference identifies a single unique letter or a batch of letters. It must not contain any personal information such as name or postal address. For example:
+An identifier you can create if necessary. This reference identifies a single unique letter or a batch of letters. It must not contain any personal information such as name or postal address. For example:
 
 ```python
 reference="your reference" # optional string - identifies notification(s)
@@ -569,7 +569,7 @@ If the request to the client is successful, the client returns a `dict`:
   "reference": "your reference",  # optional string - reference you provided when sending the message
   "content": {
     "subject": "Your upcoming pigeon registration appointment",  # required string - letter heading
-    "body": "Dear Amala\r\n\r\nYour pigeon registration appointment is scheduled for 2018-01-01 at 01:00PM.\r\n\r\nPlease bring:\r\n\n\n* passport\n* utility bill\n* other id\r\n\r\nYours,\r\nPigeon Affairs Bureau",  # required string - letter content
+    "body": "Dear Amala\r\n\r\nYour pigeon registration appointment is scheduled for 1 January 2018 at 1:00pm.\r\n\r\nPlease bring:\r\n\n\n* passport\n* utility bill\n* other id\r\n\r\nYours,\r\nPigeon Affairs Bureau",  # required string - letter content
   },
   "uri": "https://api.notifications.service.gov.uk/v2/notifications/3d1ce039-5476-414c-99b2-fac1e6add62c",  # required string
   "template": {
@@ -615,7 +615,7 @@ with open("path/to/pdf_file.pdf", "rb") as pdf_file:
 
 ##### reference (required)
 
-A unique identifier you create. This reference identifies a single unique precompiled letter or a batch of precompiled letters. It must not contain any personal information such as name or postal address.
+An identifier you create. This reference identifies a single unique precompiled letter or a batch of precompiled letters. It must not contain any personal information such as name or postal address.
 
 ```python
 reference="your reference" # required string - identifies notification(s)
@@ -712,7 +712,7 @@ If the request to the client is successful, the client will return a `dict`:
         "id": "f33517ff-2a88-4f6e-b855-c550268ce08a",  # required string - template ID
         "uri": "/v2/template/{id}/{version}"  # required string
     },
-    "body": "Hi Amala, your appointment is on 2018-01-01 at 01:00PM",  # required string - body of notification
+    "body": "Hi Amala, your appointment is on 1 January 2018 at 1:00pm",  # required string - body of notification
     "subject": "Your upcoming pigeon registration appointment",  # required string for email - subject of email
     "created_at": "2024-05-17 15:58:38.342838",  # required string - date and time notification created
     "created_by_name": "Charlie Smith",  # optional string - name of the person who sent the notification if sent manually
@@ -827,7 +827,7 @@ You can leave out this argument to ignore this filter.
 
 ##### reference (optional)
 
-A unique identifier you can create if necessary. This reference identifies a single unique message or a batch of messages. It must not contain any personal information such as name or postal address. For example:
+An identifier you can create if necessary. This reference identifies a single unique message or a batch of messages. It must not contain any personal information such as name or postal address. For example:
 
 ```python
 reference="your reference" # optional string - reference you provided when sending the message
@@ -882,7 +882,7 @@ If the request to the client is successful, the client returns a `dict`.
                 "id": "f33517ff-2a88-4f6e-b855-c550268ce08a",  # required string - template ID
                 "uri": "/v2/template/{id}/{version}"  # required string
             },
-            "body": "Hi Amala, your appointment is on 2018-01-01 at 01:00PM",  # required string - body of notification
+            "body": "Hi Amala, your appointment is on 1 January 2018 at 1:00pm",  # required string - body of notification
             "subject": "Your upcoming pigeon registration appointment",  # required string for email - subject of email
             "created_at": "2024-05-17 15:58:38.342838",  # required string - date and time notification created
             "created_by_name": "Charlie Smith",  # optional string - name of the person who sent the notification if sent manually
@@ -1202,7 +1202,7 @@ response = notifications_client.post_template_preview(
     template_id="f33517ff-2a88-4f6e-b855-c550268ce08a",
     personalisation={
         "first_name": "Amala",
-        "appointment_date": "2018-01-01 at 01:00PM",
+        "appointment_date": "1 January 2018 at 1:00pm",
     }
 )
 ```
@@ -1228,7 +1228,7 @@ If a template has placeholder fields for personalised information such as name o
 ```python
 personalisation={
     "first_name": "Amala",
-    "appointment_date": "2018-01-01 at 01:00PM",
+    "appointment_date": "1 January 2018 at 1:00pm",
     "required_documents": ["passport", "utility bill", "other id"],
 },
 ```
@@ -1243,7 +1243,7 @@ If the request to the client is successful, you receive a `dict` response.
     "type": "sms / email / letter" , # required string
     "version": 3,
     # required string - body of notification
-    "body": "Dear Amala\r\n\r\nYour pigeon registration appointment is scheduled for 2018-01-01 at 01:00PM.\r\n\r\n Here is a link to your invitation document:\r\n\n\n* passport\n* utility bill\n* other id\r\n\r\nPlease bring the invite with you to the appointment.\r\n\r\nYours,\r\nPigeon Affairs Bureau",
+    "body": "Dear Amala\r\n\r\nYour pigeon registration appointment is scheduled for 1 January 2018 at 1:00pm.\r\n\r\n Here is a link to your invitation document:\r\n\n\n* passport\n* utility bill\n* other id\r\n\r\nPlease bring the invite with you to the appointment.\r\n\r\nYours,\r\nPigeon Affairs Bureau",
     # required string for emails, empty for sms and letters - html version of the email body
     "html": '<p style="Margin: 0 0 20px 0; font-size: 19px; line-height: 25px; color: #0B0C0C;">Dear Amala</p> ... [snippet truncated for readability]',
     # required string for email and letter - subject of email / heading of letter