Merge pull request #225 from barseghyanartur/dev

Docs/fixes (#224)

.github/workflows/test.yml

@@ -173,12 +173,15 @@ jobs:
           - "3.10"
           - "3.9"
         django-version: [
+          "5.1",
           "5.0",
           "4.2"
         ]
         exclude:
           - python-version: "3.9"
             django-version: "5.0"  # Exclude Python 3.9 with Django 5.0
+          - python-version: "3.9"
+            django-version: "5.1"  # Exclude Python 3.9 with Django 5.1
     steps:
       - name: Clean-up
         run: sudo apt clean && sudo apt autoclean && sudo rm -rf /tmp/* && sudo rm -rf /usr/share/dotnet && sudo rm -rf /opt/ghc && sudo rm -rf "/usr/local/share/boost" && sudo rm -rf "$AGENT_TOOLSDIRECTORY"

CHANGELOG.rst

@@ -23,6 +23,7 @@ are used for versioning (schema follows below):
 - Add benchmarks section to the main README.
 - Improve docs. Add a dedicated section on files creation.
 - Minor clean-up.
+- Test against Django 5.1.
 
 0.10.4
 ------

docs/creating_files.rst

@@ -24,7 +24,6 @@ This section covers basic concepts of file generation within `fake.py`_.
 It's possible to generate either bytes or files on the file system.
 
 - When generating bytes, the returned value is ``BytesValue``.
-
 - When generating files on the file system, the returned value
   is ``StringValue``.
 
@@ -40,7 +39,7 @@ For generated files, it will always have the following:
 
 ----
 
-See the example below for a graphic PDF generation:
+See the example below for a **graphic** PDF generation:
 
 .. container:: jsphinx-toggle-emphasis
 
@@ -52,20 +51,20 @@ See the example below for a graphic PDF generation:
 
         pdf_file = FAKER.pdf_file()
 
-        print(pdf_file)
+        print(pdf_file)  # Relative path
         # tmp/tmpnvwoa2ap.pdf
 
-        print(pdf_file.data["filename"])
+        print(pdf_file.data["filename"])  # Absolute path
         # /tmp/tmp/tmpnvwoa2ap.pdf
 
-        print(pdf_file.data)
+        print(pdf_file.data)  # Meta-data
         # {'storage': <fake.FileSystemStorage at 0x7f72221fd750>,
         #  'filename': '/tmp/tmp/tmpragc8wyr.pdf',
         #  'content': None}
 
 ----
 
-See the example below for a text PDF generation:
+See the example below for a **text** PDF generation:
 
 .. container:: jsphinx-toggle-emphasis