function_method_template.md

id
title
section
module
subscription
difficulty
reference
tags
see_also
works_with
file_path

Name

• Used with: # List main types this works with, e.g. lists, dicts
• Construct: # Function or method? Show how it is called
• Library: # Built-in, or module name if not built-in
• Iterable: # Does it work with iterables? (yes/no/which)
• Time Complexity: # (if known; skip or estimate if not)

Description

➡️ What does this function/method do?
When and why would you use it?
Anything unique about its behavior?

Usable With

➡️ Which data types is this function/method used with?
E.g., works on lists, strings, dicts, etc.

Syntax

# ➡️ Write the most typical usage pattern here.

• explanation: explain syntax

Arguments

• Required: # List and explain required arguments

• Optional: # List and explain optional arguments

• Maximum: # If there are variadic or flexible arguments, note here

• Required:

# Show usage with only required arguments

• Optional:

# Show usage with optional arguments as well

• Maximum

# If there's a max/flexible usage, show it

Examples

• name of example # Describe what the example does

# Example code here

• name of example # Describe what the example does

# Another example code

• name of example # Describe what the example does

# Another example code

Note: # Any additional notes about edge cases or behavior

Tips & Common mistakes

• Write at least 2–3 tips or common pitfalls
• Best practices
• Things beginners get wrong

# Short code illustration (if needed)

See Also

➡️ List related types, key methods, and concepts in label format.- tuple