Define Requirements for Utility Functions (iss-8216651862d3)
This commit is contained in:
parent
df4a695937
commit
9b994ed4ec
1 changed files with 37 additions and 0 deletions
37
docs/utility_functions_requirements.md
Normal file
37
docs/utility_functions_requirements.md
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
# Utility Functions Requirements
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
This document outlines the requirements for the utility functions to be implemented in the project.
|
||||||
|
|
||||||
|
## Function 1: `calculate_sum`
|
||||||
|
### Description
|
||||||
|
Calculates the sum of two numbers.
|
||||||
|
### Input Parameters
|
||||||
|
- `num1` (float): The first number.
|
||||||
|
- `num2` (float): The second number.
|
||||||
|
### Expected Output
|
||||||
|
- (float): The sum of `num1` and `num2`.
|
||||||
|
|
||||||
|
## Function 2: `is_even`
|
||||||
|
### Description
|
||||||
|
Determines if a given number is even.
|
||||||
|
### Input Parameters
|
||||||
|
- `number` (int): The number to check.
|
||||||
|
### Expected Output
|
||||||
|
- (bool): Returns `true` if the number is even, `false` otherwise.
|
||||||
|
|
||||||
|
## Function 3: `string_to_upper`
|
||||||
|
### Description
|
||||||
|
Converts a given string to uppercase.
|
||||||
|
### Input Parameters
|
||||||
|
- `input_string` (str): The string to convert.
|
||||||
|
### Expected Output
|
||||||
|
- (str): The uppercase version of `input_string`.
|
||||||
|
|
||||||
|
## Function 4: `get_unique_elements`
|
||||||
|
### Description
|
||||||
|
Returns a list of unique elements from the input list.
|
||||||
|
### Input Parameters
|
||||||
|
- `input_list` (list): The list from which to extract unique elements.
|
||||||
|
### Expected Output
|
||||||
|
- (list): A list containing unique elements from `input_list`.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue