Merge pull request #73 from braboj/codex/update-headers-in-python-examples

Clarify example headers

Author: braboj

examples/01_hello_world/hello_world.py

@@ -1,8 +1,7 @@
 # Hello World example
 # ----------------------------------------------------------------------------
-# This is a simple example to demonstrate the most basic functionality of
-# Python. It prints "Hello world!" to the console and performs a simple
-# arithmetic operation (1 + 1).
+# This simple program prints "Hello world!" and performs a basic
+# addition (1 + 1) to highlight Python's core syntax.
 
 print("Hello world!")
 print(1 + 1)

examples/02_variables/string_cases.py

@@ -1,6 +1,6 @@
 # String case manipulation examples
 # -----------------------------------------------------------------------------
-# This code demonstrates various string case manipulation methods in Python.
+# This code applies various string case manipulation methods in Python.
 
 # Store the string to be manipulated
 text = "AAAA bbbb"

examples/02_variables/string_concatenation.py

@@ -1,9 +1,8 @@
 # String concatenation example
 # -----------------------------------------------------------------------------
-# This code demonstrates how to concatenate (join) strings in Python. The
-# `+` operator is used to combine multiple strings into one. This is a common
-# operation in Python, especially when constructing messages or combining
-# text from different sources.
+# This code concatenates (joins) strings using the `+` operator. This
+# technique is common when constructing messages or combining text from
+# different sources.
 
 
 string1 = 'Hello'

examples/02_variables/string_escaping.py

@@ -1,8 +1,8 @@
 # Escape sequences in Python strings
 # -----------------------------------------------------------------------------
-# This code demonstrates how to use escape sequences in Python strings. Escape
-# sequences are special characters that allow you to include characters in a
-# string that would otherwise be difficult or impossible to include directly.
+# This example uses escape sequences in strings so you can include
+# characters that would otherwise be difficult or impossible to type
+# directly.
 #
 # Special characters:
 # - `\n` for new line

examples/02_variables/string_indexing.py

@@ -1,10 +1,8 @@
 # String indexing
 # -----------------------------------------------------------------------------
-# This code demonstrates how to access individual characters in a string using
-# indexing. In Python, strings are sequences of characters, and you can access
-# each character by its index. The index starts at 0 for the first character,
-# and you can also use negative indices to access characters from the end
-# of the string.
+# This code accesses individual characters in a string by index. Strings are
+# sequences of characters, so index 0 refers to the first character, and
+# negative indices let you read characters from the end of the string.
 
 string = "Hello, world!"
 

examples/02_variables/string_interpolation.py

@@ -1,8 +1,8 @@
 # String interpolation
 # -----------------------------------------------------------------------------
-# This code demonstrates how to use f-strings (formatted string literals) in
-# Python to create strings that include variables. F-strings allow you to
-# embed expressions inside string literals, using curly braces `{}`.
+# This code uses f-strings (formatted string literals) to create strings
+# that include variables. Expressions inside curly braces `{}` are
+# evaluated in place.
 
 first_name = "Branimir"
 last_name = "Georgiev"

examples/02_variables/string_length.py

@@ -1,9 +1,8 @@
 # Calculate the length of a string
 # -----------------------------------------------------------------------------
-# This code demonstrates how to calculate the symbol length of a string in
-# Python. Bear in mind that this is not the same as the byte length of the
-# string, which can be different if the string contains  UTF-8 characters that
-# are represented by multiple bytes.
+# This snippet calculates the number of characters in a string. The
+# result differs from the byte length when the string contains UTF-8
+# characters that use multiple bytes.
 
 text = "0123456789"
 print(len(text))

examples/02_variables/string_slicing.py

@@ -1,8 +1,8 @@
 # String slicing
 # -----------------------------------------------------------------------------
-# This code demonstrates how to slice strings in Python. String slicing allows
-# you to extract a portion of a string by specifying a start index, an end index,
-# and an optional step. The syntax for slicing is `string[start:end:step]`.
+# This code slices strings in Python. Slicing extracts a portion of a string
+# by specifying a start index, an end index, and an optional step using
+# the syntax `string[start:end:step]`.
 #
 # The `start` index is inclusive, the `end` index is exclusive, and the `step`
 # determines the increment between each index in the slice. The default values

examples/02_variables/var_as_container.py

@@ -1,9 +1,8 @@
 # Variable as a container
 # -----------------------------------------------------------------------------
-# This code demonstrates how a variable can be used as a container for data.
-# In this case, the variable `text` is used to store a string value, which can
-# be reused multiple times in the code. The variable is a fundamental concept in
-# programming, allowing you to store and manipulate data efficiently.
+# This code uses a variable as a container for data. The variable `text`
+# stores a string value that can be reused multiple times, illustrating how
+# variables allow you to store and manipulate data efficiently.
 
 text = 'Hello world!'
 print(text)

examples/02_variables/var_bool_type.py

@@ -1,8 +1,8 @@
 # Boolean variables
 # -----------------------------------------------------------------------------
-# This code demonstrates how to use boolean variables in Python. They are
-# used to represent truth values, which can be either `True` or `False`. Boolean
-# variables are often used in conditional statements and logical operations.
+# This example uses boolean variables to represent truth values—either
+# `True` or `False`. Such variables are often part of conditional
+# statements and logical operations.
 
 var = False
 print(var)