Function Template Generator

When to use

• When starting a new MATLAB function file.
• When drafting a Python function with basic, type-hint, NumPy-style, Google-style, or script-call structure.
• When standardizing documentation before implementation.

How to use

1. Enter the code, error text, shape values, or template details requested by the form.
2. Choose the relevant language, style, operation, or option set, then click Generate Function Template.
3. Review warnings and unsupported-pattern notes before copying or downloading the result.
4. Paste the generated snippet into your own MATLAB or Python environment only after inspection and testing.

Inputs

Function metadata

Language, function name, arguments, outputs, descriptions, validation comments, example, TODO flag, and doc style.

Notation

Output explanation

• Python or MATLAB function skeleton.
• Docstring or help-block text.
• Validation warnings for names, duplicates, and reserved words.

Supported patterns

• Python basic, type-hint, NumPy docstring, Google docstring, and script-call templates
• MATLAB function file, multiple-output, help-block, validation-comment, and example templates
• identifier and duplicate checks

Unsupported patterns

• automatic implementation of the function body
• inferring types from runtime data
• package or class scaffolding

Interpretation

• Treat generated code as a starting point that must be tested with representative data.
• Warnings identify cases where the rule-based helper cannot prove semantic equivalence.
• The visual summary is a checklist or structure preview, not an execution trace.

Code-helper guidance

• Keep one purpose per generated function.
• Write a minimal example before filling in complex implementation details.

Worked examples

Assumptions

• The generated function body is a placeholder until the user implements and tests it.
• Docstring content should be edited for the real algorithm.

Practical guidance

• Keep one purpose per generated function.
• Write a minimal example before filling in complex implementation details.

Common mistakes

• Using spaces or hyphens in function names.
• Naming an argument the same as a built-in or output without a clear reason.

Limitations

• The helper does not execute MATLAB, Python, NumPy, pandas, or Matplotlib code.
• Generated snippets may require imports, workspace variables, data cleaning, or environment-specific changes.
• The rule set does not replace code review, unit tests, validated numerical software, or qualified professional judgment.

Related workflow links