Skip to content

Commit

Permalink
feat: class doc string
Browse files Browse the repository at this point in the history
doc strings
  • Loading branch information
DamianFlynn committed Nov 16, 2022
1 parent 08cc7c6 commit 536f426
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
Binary file modified obsidian_parser/__pycache__/multiplication.cpython-310.pyc
Binary file not shown.
20 changes: 18 additions & 2 deletions obsidian_parser/multiplication.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
class Multiplication:
"""Multiply number by multiplier."""
"""
Instantiate a multiplication operation.
Numbers will be multiplied by the given multiplier.
:param multiplier: The multiplier.
:type multiplier: float
"""

def __init__(self, multiplier: float):
"""Initialize multiplier."""
self.multiplier = multiplier

def multiply(self, number: float) -> float:
"""Multiply number by multiplier."""
"""
Multiply a given number by the multiplier.
:param number: The number to multiply.
:type number: float
:return: The result of the multiplication.
:rtype: float
"""
return number * self.multiplier

0 comments on commit 536f426

Please sign in to comment.