Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 879 Bytes

template.md

File metadata and controls

42 lines (32 loc) · 879 Bytes

Class Documentation Template

# [Class Name]

## Overview
Brief description of the file's purpose and functionality.

## Dependencies
- Dependency 1
- Dependency 2

## Definition (If applicable)

## Attributes
| Attribute | Type | Description |
|-----------|------|-------------|
| attr1 | type | Description of attribute |
| attr2 | type | Description of attribute |

## Methods
i.e.
### method_name(param1, param2)
```python
def method_name(self, param1: type, param2: type) -> return_type:
    """
    Brief description of method functionality.

    Args:
        param1: Description of first parameter
        param2: Description of second parameter

    Returns:
        Description of return value

    Raises:
        ExceptionType: Description of when this exception occurs
    """

Usage Examples

usage examples in code blocks go here if applicable