From 3322172a278b0eb0ac63edb24d1bc53da20a044b Mon Sep 17 00:00:00 2001
From: Sina Atalay <dev@atalay.biz>
Date: Sun, 3 Nov 2024 01:35:37 -0400
Subject: [PATCH] docs: don't use python formatting for inline strings

---
 rendercv/cli/utilities.py           |  2 +-
 rendercv/data/models/computers.py   |  8 ++++----
 rendercv/data/models/entry_types.py |  4 ++--
 rendercv/renderer/templater.py      | 16 ++++++++--------
 tests/conftest.py                   |  2 +-
 5 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/rendercv/cli/utilities.py b/rendercv/cli/utilities.py
index b544eaa7..23d96aaf 100644
--- a/rendercv/cli/utilities.py
+++ b/rendercv/cli/utilities.py
@@ -122,7 +122,7 @@ def get_latest_version_number_from_pypi() -> Optional[str]:
         get_latest_version_number_from_pypi()
         ```
         returns
-        `#!python "1.1"`
+        `"1.1"`
 
     Returns:
         The latest version number of RenderCV from PyPI. Returns None if the version
diff --git a/rendercv/data/models/computers.py b/rendercv/data/models/computers.py
index eaefe59d..043ccbd2 100644
--- a/rendercv/data/models/computers.py
+++ b/rendercv/data/models/computers.py
@@ -54,7 +54,7 @@ def format_date(date: Date, date_style: Optional[str] = None) -> str:
         ```
         will return
 
-        `#!python "May 2024"`
+        `"May 2024"`
 
     Args:
         date: The date to format.
@@ -138,7 +138,7 @@ def compute_time_span_string(
 
         returns
 
-        `#!python "4 months"`
+        `"4 months"`
 
     Args:
         start_date: A start date in YYYY-MM-DD, YYYY-MM, or YYYY format.
@@ -299,7 +299,7 @@ def make_a_url_clean(url: str) -> str:
         make_a_url_clean("https://www.example.com/")
         ```
         returns
-        `#!python "example.com"`
+        `"example.com"`
 
     Args:
         url: The URL to make clean.
@@ -355,7 +355,7 @@ def dictionary_key_to_proper_section_title(key: str) -> str:
         dictionary_key_to_proper_section_title("section_title")
         ```
         returns
-        `#!python "Section Title"`
+        `"Section Title"`
 
     Args:
         key: The key to convert to a proper section title.
diff --git a/rendercv/data/models/entry_types.py b/rendercv/data/models/entry_types.py
index 00cc406f..0c1d61b2 100644
--- a/rendercv/data/models/entry_types.py
+++ b/rendercv/data/models/entry_types.py
@@ -354,7 +354,7 @@ class EntryBase(EntryWithDate):
             entry = dm.EntryBase(start_date="2020-10-11", end_date="2021-04-04").date_string
             ```
             returns
-            `#!python "Nov 2020 to Apr 2021"`
+            `"Nov 2020 to Apr 2021"`
         """
         return computers.compute_date_string(
             start_date=self.start_date, end_date=self.end_date, date=self.date
@@ -371,7 +371,7 @@ class EntryBase(EntryWithDate):
             entry = dm.EntryBase(start_date="2020-10-11", end_date="2021-04-04").date_string_only_years
             ```
             returns
-            `#!python "2020 to 2021"`
+            `"2020 to 2021"`
         """
         return computers.compute_date_string(
             start_date=self.start_date,
diff --git a/rendercv/renderer/templater.py b/rendercv/renderer/templater.py
index fcbe8493..4992f14a 100644
--- a/rendercv/renderer/templater.py
+++ b/rendercv/renderer/templater.py
@@ -325,7 +325,7 @@ def escape_latex_characters(latex_string: str) -> str:
         escape_latex_characters("This is a # string.")
         ```
         returns
-        `#!python "This is a \\# string."`
+        `"This is a \\# string."`
 
     Args:
         latex_string: The string to escape.
@@ -405,7 +405,7 @@ def markdown_to_latex(markdown_string: str) -> str:
 
         returns
 
-        `#!python "This is a \\textbf{bold} text with a \\href{https://google.com}{\\textit{link}}."`
+        `"This is a \\textbf{bold} text with a \\href{https://google.com}{\\textit{link}}."`
 
     Args:
         markdown_string: The Markdown string to convert.
@@ -568,7 +568,7 @@ def make_matched_part_bold(value: str, match_str: Optional[str] = None) -> str:
 
         returns
 
-        `#!python "\\textbf{Hello} World!"`
+        `"\\textbf{Hello} World!"`
 
     Args:
         value: The string to make bold.
@@ -593,7 +593,7 @@ def make_matched_part_underlined(value: str, match_str: Optional[str] = None) ->
 
         returns
 
-        `#!python "\\underline{Hello} World!"`
+        `"\\underline{Hello} World!"`
 
     Args:
         value: The string to make underlined.
@@ -618,7 +618,7 @@ def make_matched_part_italic(value: str, match_str: Optional[str] = None) -> str
 
         returns
 
-        `#!python "\\textit{Hello} World!"`
+        `"\\textit{Hello} World!"`
 
     Args:
         value: The string to make italic.
@@ -645,7 +645,7 @@ def make_matched_part_non_line_breakable(
 
         returns
 
-        `#!python "\\mbox{Hello} World!"`
+        `"\\mbox{Hello} World!"`
 
     Args:
         value: The string to disable line breaks.
@@ -669,7 +669,7 @@ def abbreviate_name(name: Optional[str]) -> str:
 
         returns
 
-        `#!python "J. Doe"`
+        `"J. Doe"`
 
     Args:
         name: The name to abbreviate.
@@ -706,7 +706,7 @@ def divide_length_by(length: str, divider: float) -> str:
 
         returns
 
-        `#!python "5.2cm"`
+        `"5.2cm"`
 
     Args:
         length: The length to divide.
diff --git a/tests/conftest.py b/tests/conftest.py
index 8389867f..f6ed98a7 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -154,7 +154,7 @@ def return_a_value_for_a_field_type(
         return_a_value_for_a_field_type("institution", str)
         ```
         returns
-        `#!python "Boğaziçi University"`
+        `"Boğaziçi University"`
 
     Args:
         field_type: The type of the field.