TEMPLATE.md

FunctionName

⏰ Yields 🌎 Global 🪲 Inconsistent 🔎 Needs Investigation 📌 Custom Tag

function FunctionName(param: string): ()

Describe the function in a neat and concise manner.

May include multiple lines, paragraphs, or info cards.

🔎 Notes, tips, info

Additional information or URLs.

⚠️ Warnings, risks

Exercise caution.

⛔ Danger!

Avoid making this mistake.

🪲 Bugs, issues

Document known issues.

Parameters

• param - The parameter description.

Aliases

• functionAlias
• badAlias - Optional justification.

Example

A description of the example that follows.

print(FunctionName()) --> (void)