Skip to main content

feray

This is the auto-generated API reference for the feray library. It is generated directly from the docstrings in the Python source code.

feray core​

This section covers the main components of the library.

class feray.Calculator​

Bases: object

A class that performs calculations.

This is a simple example of a class that can be documented.

last_result​

The result of the last calculation.

  • Type: float

add(a: float, b: float) → float​

Adds two numbers together.

  • Parameters:
    • a (float) – The first number.
    • b (float) – The second number.
  • Returns: The sum of the two numbers.
  • Return type: float
  • Raises: TypeError – If inputs are not numeric.

feray.hello() → str​

feray.subtract(a: float, b: float) → float​

A standalone function to subtract two numbers.

  • Parameters:
    • a (float) – The number to subtract from.
    • b (float) – The number to subtract.
  • Returns: The difference between a and b.
  • Return type: float

Calculator Example​

A simple module to demonstrate functionality.

A very simple calculator module.

This module provides basic arithmetic operations. It’s designed to demonstrate how documentation can be generated from docstrings.

class feray.calculator.Calculator​

Bases: object

A class that performs calculations.

This is a simple example of a class that can be documented.

last_result​

The result of the last calculation.

  • Type: float

add(a: float, b: float) → float​

Adds two numbers together.

  • Parameters:
    • a (float) – The first number.
    • b (float) – The second number.
  • Returns: The sum of the two numbers.
  • Return type: float
  • Raises: TypeError – If inputs are not numeric.

feray.calculator.subtract(a: float, b: float) → float​

A standalone function to subtract two numbers.

  • Parameters:
    • a (float) – The number to subtract from.
    • b (float) – The number to subtract.
  • Returns: The difference between a and b.
  • Return type: float