Enhance documentation by adding examples and relevant links for built-in functions

Author: wilfredinni

docs/builtin/abs.md

@@ -20,27 +20,37 @@ Python abs() built-in function
 
 The `abs()` function in Python is a built-in function that returns the absolute value of a number. It can handle integers, floating-point numbers, and even complex numbers (returning their magnitude). This function is useful when you need to ensure a value is positive, regardless of its original sign.
 
+### Examples
+
 ```python
+# For integers
 >>> abs(-1)
 # 1
 >>> abs(0)
 # 0
->>> abs(1)
-# 1
->>> abs(3.14)
+
+# For floats
+>>> abs(-3.14)
 # 3.14
->>> abs(3 + 2j)
-# 3.6055512754639896
->>> abs(0x10)
+
+# For complex numbers (returns magnitude)
+>>> abs(3 + 4j)
+# 5.0
+
+# For other number systems
+>>> abs(0x10) # Hexadecimal
 # 16
->>> abs(0b10)
+>>> abs(0b10) # Binary
 # 2
->>> abs(0o20)
+>>> abs(0o20) # Octal
 # 16
 ```
 
 ## Relevant links
 
-- <router-link :to="'/builtin/float'">float()</router-link>
-- <router-link :to="'/builtin/int'">`int()`</router-link>
-- <router-link :to="'/builtin/complex'">complex()</router-link>
+- <router-link to="/blog/python-data-types">Blog: Python Data Types</router-link>
+- <router-link to="/builtin/pow">pow()</router-link>
+- <router-link to="/builtin/round">round()</router-link>
+- <router-link to="/builtin/int">int()</router-link>
+- <router-link to="/builtin/float">float()</router-link>
+- <router-link to="/builtin/complex">complex()</router-link>

docs/builtin/aiter.md

@@ -18,18 +18,51 @@ Python aiter() built-in function
 
 ## Introduction
 
-The `aiter()` function in Python is a built-in function that returns an asynchronous iterator for an asynchronous iterable. This is the asynchronous equivalent of the `iter()` function and is essential when working with asynchronous loops (`async for`). It allows you to iterate over objects that produce values asynchronously.
+The `aiter()` function returns an asynchronous iterator from an asynchronous iterable object. It's the asynchronous equivalent of the `iter()` function.
+
+You'll typically use `aiter()` implicitly when using an `async for` loop, but you can call it directly if you need to work with the iterator manually, often in conjunction with `anext()`.
 
 ## Example
 
+Here's an example of an asynchronous iterable. The `async for` loop automatically calls `aiter()` on the `AsyncCounter` object to get an iterator.
+
 ```python
->>> async def aitersync(iterable):
-...    results = []
-...    async for x in aiter(iterable):
-...        results.append(x)
-...    return iter(results)
+import asyncio
+
+class AsyncCounter:
+    def __init__(self, stop):
+        self.stop = stop
+        self.current = 0
+
+    def __aiter__(self):
+        return self
+
+    async def __anext__(self):
+        if self.current < self.stop:
+            await asyncio.sleep(0.1)
+            value = self.current
+            self.current += 1
+            return value
+        else:
+            raise StopAsyncIteration
+
+async def main():
+    async for number in AsyncCounter(3):
+        print(number)
+
+# To run this in a real environment:
+# asyncio.run(main())
+#
+# Output:
+# 0
+# 1
+# 2
 ```
 
 ## Relevant links
 
-- <router-link :to="'/builtin/iter'">iter()</router-link>
+- <router-link to="/cheatsheet/control-flow">Cheatsheet: Control Flow (async for)</router-link>
+- <router-link to="/cheatsheet/functions">Cheatsheet: Functions (async def)</router-link>
+- <router-link to="/modules/itertools-module">Module: itertools</router-link>
+- <router-link to="/builtin/iter">iter()</router-link>
+- <router-link to="/builtin/next">next()</router-link>

docs/builtin/all.md

@@ -23,19 +23,31 @@ The `all()` function in Python is a built-in function that checks if all element
 ## Examples
 
 ```python
->>> all([True, True, True])
+# All values are truthy
+>>> all([1, 2, 3])
 # True
 
->>> all((0, True, False))
+# Contains a falsy value (0)
+>>> all([1, 0, 3])
 # False
 
->>> all({1, 1, 1})
+# Contains a falsy value (empty string)
+>>> all(['a', '', 'c'])
+# False
+
+# An empty iterable is considered True
+>>> all([])
 # True
 ```
 
 ## Relevant links
 
-- <router-link :to="'/builtin/any'">any()</router-link>
-- <router-link :to="'/cheatsheet/control-flow'">Control Flow</router-link>
-- <router-link :to="'/cheatsheet/comprehensions'">Comprehensions</router-link>
-- <router-link :to="'/blog/python-data-types'">Python Data Types</router-link>
+- <router-link to="/cheatsheet/control-flow">Cheatsheet: Control Flow</router-link>
+- <router-link to="/cheatsheet/comprehensions">Cheatsheet: Comprehensions</router-link>
+- <router-link to="/blog/python-data-types">Blog: Python Data Types</router-link>
+- <router-link to="/builtin/any">any()</router-link>
+- <router-link to="/builtin/bool">bool()</router-link>
+- <router-link to="/builtin/list">list()</router-link>
+- <router-link to="/builtin/tuple">tuple()</router-link>
+- <router-link to="/builtin/set">set()</router-link>
+- <router-link to="/builtin/dict">dict()</router-link>

docs/builtin/any.md

@@ -23,19 +23,27 @@ The `any()` function in Python is a built-in function that checks if at least on
 ## Examples
 
 ```python
->>> any([False, False, False])
+# All values are falsy
+>>> any([0, '', False])
 # False
 
->>> any((0, True, False))
+# Contains one truthy value (2)
+>>> any([0, 2, False])
 # True
 
->>> any({0, 0, 0})
+# An empty iterable is considered False
+>>> any([])
 # False
 ```
 
 ## Relevant links
 
-- <router-link :to="'/builtin/all'">all()</router-link>
-- <router-link :to="'/cheatsheet/control-flow'">Control Flow</router-link>
-- <router-link :to="'/cheatsheet/comprehensions'">Comprehensions</router-link>
-- <router-link :to="'/blog/python-data-types'">Python Data Types</router-link>
+- <router-link to="/cheatsheet/control-flow">Cheatsheet: Control Flow</router-link>
+- <router-link to="/cheatsheet/comprehensions">Cheatsheet: Comprehensions</router-link>
+- <router-link to="/blog/python-data-types">Blog: Python Data Types</router-link>
+- <router-link to="/builtin/all">all()</router-link>
+- <router-link to="/builtin/bool">bool()</router-link>
+- <router-link to="/builtin/list">list()</router-link>
+- <router-link to="/builtin/tuple">tuple()</router-link>
+- <router-link to="/builtin/set">set()</router-link>
+- <router-link to="/builtin/dict">dict()</router-link>

docs/builtin/ascii.md

@@ -23,20 +23,29 @@ The `ascii()` function in Python is a built-in function that returns a string co
 ## Examples
 
 ```python
+# For an ASCII character, it's the same as repr()
 >>> ascii('A')
-# 'A'
+# "'A'"
 
+# For a non-ASCII character, it gets escaped
 >>> ascii('ë')
-# '\xeb'
+# "'\\xeb'"
 
+# For comparison, repr() would not escape it
+>>> repr('ë')
+# "'ë'"
+
+# It works on iterables too
 >>> ascii(['A', 'ë'])
-# ['A', '\xeb']
+# "['A', '\\xeb']"
 ```
 
 ## Relevant links
 
-- <router-link :to="'/builtin/repr'">repr()</router-link>
-- <router-link :to="'/builtin/str'">str()</router-link>
-- <router-link :to="'/builtin/chr'">chr()</router-link>
-- <router-link :to="'/builtin/ord'">ord()</router-link>
-- <router-link :to="'/cheatsheet/manipulating-strings'">Manipulating Strings</router-link>
+- <router-link to="/cheatsheet/manipulating-strings">Cheatsheet: Manipulating Strings</router-link>
+- <router-link to="/blog/python-data-types">Blog: Python Data Types</router-link>
+- <router-link to="/builtin/repr">repr()</router-link>
+- <router-link to="/builtin/str">str()</router-link>
+- <router-link to="/builtin/bytes">bytes()</router-link>
+- <router-link to="/builtin/chr">chr()</router-link>
+- <router-link to="/builtin/ord">ord()</router-link>

docs/builtin/bin.md

@@ -36,6 +36,9 @@ print(bin(1000)) # Output: 0b1111101000
 
 ## Relevant links
 
-- <router-link :to="'/builtin/int'">int()</router-link>
-- <router-link :to="'/builtin/hex'">hex()</router-link>
-- <router-link :to="'/builtin/oct'">oct()</router-link>
+- <router-link to="/blog/python-data-types">Blog: Python Data Types</router-link>
+- <router-link to="/cheatsheet/string-formatting">Cheatsheet: String Formatting</router-link>
+- <router-link to="/builtin/int">int()</router-link>
+- <router-link to="/builtin/hex">hex()</router-link>
+- <router-link to="/builtin/oct">oct()</router-link>
+- <router-link to="/builtin/format">format()</router-link>

docs/builtin/bool.md

@@ -22,30 +22,55 @@ The `bool()` function in Python is a built-in function that converts a value to
 
 ## Examples
 
+### Falsy Values
+These values are considered `False`:
+
 ```python
+>>> bool(False)
+# False
+>>> bool(None)
+# False
 >>> bool(0)
 # False
+>>> bool(0.0)
+# False
+>>> bool('')      # empty string
+# False
+>>> bool([])      # empty list
+# False
+>>> bool({})      # empty dict
+# False
+>>> bool(set())   # empty set
+# False
+```
+
+### Truthy Values
+Most other values are considered `True`:
 
+```python
+>>> bool(True)
+# True
 >>> bool(1)
 # True
-
->>> bool(2)
+>>> bool(-1)
 # True
-
->>> bool('3')
+>>> bool('hello')
 # True
-
->>> bool(False)
-# False
-
->>> bool(True)
+>>> bool([1, 2])
+# True
+>>> bool({'a': 1})
 # True
 ```
 
 ## Relevant links
 
-- <router-link :to="'/builtin/int'">int()</router-link>
-- <router-link :to="'/builtin/all'">all()</router-link>
-- <router-link :to="'/builtin/any'">any()</router-link>
-- <router-link :to="'/cheatsheet/control-flow'">Control Flow</router-link>
-- <router-link :to="'/blog/python-data-types'">Python Data Types</router-link>
+- <router-link to="/cheatsheet/control-flow">Cheatsheet: Control Flow</router-link>
+- <router-link to="/blog/python-data-types">Blog: Python Data Types</router-link>
+- <router-link to="/builtin/all">all()</router-link>
+- <router-link to="/builtin/any">any()</router-link>
+- <router-link to="/builtin/int">int()</router-link>
+- <router-link to="/builtin/list">list()</router-link>
+- <router-link to="/builtin/tuple">tuple()</router-link>
+- <router-link to="/builtin/set">set()</router-link>
+- <router-link to="/builtin/dict">dict()</router-link>
+- <router-link to="/builtin/str">str()</router-link>

docs/builtin/breakpoint.md

@@ -24,26 +24,34 @@ The `breakpoint()` function in Python, introduced in Python 3.7, provides an eas
 
 ## Example
 
+Here's how you can use `breakpoint()` to pause execution and inspect variables:
+
 ```python
->>> # Create a loop over 5 integers
->>> for i in range(5):
-...     # Stream i to stdout
-...     print(i)
-...     # Create breakpoint at # 3
-...     if i == 3:
-...         breakpoint()
-...
-# 0
-# 1
-# 2
-# 3
-# > c:\users\user\path\to\your\project\example.py(24)<module>()
-# -> for i in range(5):
-# (Pdb)
+def calculate_sum(a, b):
+    result = a + b
+    # We want to inspect the 'result' before returning
+    breakpoint()
+    return result
+
+# When you run this, the debugger will start right after 'result' is calculated
+# You can then type 'result' in the (Pdb) prompt to see its value
+# To continue execution, type 'c' or 'continue'
+final_sum = calculate_sum(10, 20)
+print(final_sum)
+
+# (Pdb) result
+# 30
+# (Pdb) c
+# 30
 ```
 
 ## Relevant links
 
-- <router-link :to="'/cheatsheet/debugging'">Debugging</router-link>
-- <router-link :to="'/builtin/print'">print()</router-link>
-- <router-link :to="'/cheatsheet/control-flow'">Control Flow</router-link>
+- <router-link to="/cheatsheet/debugging">Cheatsheet: Debugging</router-link>
+- <router-link to="/cheatsheet/control-flow">Cheatsheet: Control Flow</router-link>
+- <router-link to="/builtin/print">print()</router-link>
+- <router-link to="/builtin/input">input()</router-link>
+- <router-link to="/builtin/eval">eval()</router-link>
+- <router-link to="/builtin/exec">exec()</router-link>
+- <router-link to="/builtin/globals">globals()</router-link>
+- <router-link to="/builtin/locals">locals()</router-link>