Add docstring to prompt() (#15092)

* Add docstring to prompt()

* Enhance docstring for prompt function

Updated prompt function docstring with examples.

* Enhance prompt function with width parameter

Updated prompt function to accept width parameter and modified example outputs accordingly.

---------

Co-authored-by: Jarvis Jeason Jacob <jarvis@Jarviss-MacBook-Pro.local>
Co-authored-by: Christian Clauss <cclauss@me.com>

Author: 3 people

searches/binary_tree_traversal.py

@@ -259,6 +259,20 @@ def post_order_iter(node: TreeNode) -> None:
 
 
 def prompt(s: str = "", width=50, char="*") -> str:
+    """Return a prompt string padded to the specified width.
+
+    >>> [prompt("Python", width=width) for width in range(8, 13)]
+    [' Python ', ' Python *', '* Python *', '* Python **', '** Python **']
+
+    >>> prompt("Python", width=40, char=chr(0x1F40D))
+    '🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍 Python 🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍🐍'
+
+    >>> len(prompt("Python"))
+    50
+
+    >>> prompt("Python", -200)
+    ' Python '
+    """
     if not s:
         return "\n" + width * char
     left, extra = divmod(width - len(s) - 2, 2)