Skip to content

Commit

Permalink
translate docstring in dir 'games'
Browse files Browse the repository at this point in the history
  • Loading branch information
VictorVangeli committed Oct 4, 2024
1 parent a711adf commit 3143f11
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 53 deletions.
26 changes: 13 additions & 13 deletions brain_games/games/calc.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,30 @@ def get_random_math_sign_and_result(number_one: int,
number_two: int,
operation: int) -> int:
"""
Вычисляет результат математической операции между двумя числами.
Calculates the result of a mathematical operation between two numbers.
Args:
number_one (int): Первое число.
number_two (int): Второе число.
operation (int): Операция, которую нужно выполнить ('+', '-', '*').
Args:
number_one (int): The first number
number_two (int): The second number
operation (int): The operation to be performed ('+', '-', '*')
Returns:
int: Результат выполнения операции.
"""
Returns:
int: The result of the operation.
"""
result = eval(f"{number_one} {operation} {number_two}")
return result


def get_numbers_and_calculation_result() -> tuple[str, str]:
"""
Игроку задается случайное арифметическое выражение, и он должен ввести
правильный ответ.
Если ответ верный, раунд засчитывается как выигранный.
The player is given a random arithmetic expression and must enter
the correct answer
If the answer is correct, the round is counted as won
Returns:
tuple[str, str]: Кортеж, содержащий вопрос в виде строки и правильный
ответ в виде строки.
tuple[str, str]: A tuple containing a question in the form of a string
and the correct answer in the form of a string
"""
number_one, number_two = get_random_number(), get_random_number()
operation = random.choice(["+", "-", "*"])
Expand Down
9 changes: 5 additions & 4 deletions brain_games/games/engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@

def play_game(game_round, game_rules: str):
"""
Логика игры, которая повторяет вопросы, пока пользователь не ответит
правильно несколько раз подряд.
The logic of the game, which repeats the questions until the user answers
correctly several times in a row
Args:
game_round (Callable): Функция, которая описывает один раунд игры.
game_rules (str): Правила игры, которые будут выведены перед началом.
game_round (Callable): A function that describes one round of the game.
game_rules (str): The rules of the game that will be displayed before
the start
"""
print(GREETING_MESSAGE)
username = input(ENTER_NAME)
Expand Down
20 changes: 10 additions & 10 deletions brain_games/games/even.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,30 @@

def is_even(number: int) -> bool:
"""
Проверяет, является ли число четным.
Checks if the number is even
Args:
number (int): Целое число для проверки.
number (int): An integer to check
Returns:
bool: True, если число четное, иначе False.
bool: True if the number is even, otherwise False
"""
return number % 2 == 0


def get_number_and_even_status() -> tuple[str, str]:
"""
Проводит один раунд игры, в котором игрок должен угадать, является ли число
четным.
Conducts one round of the game in which the player must guess whether the
number is even
Игроку задается случайное число, и он должен ответить 'yes', если число
четное, и 'no', если нечетное. Если игрок отвечает правильно, раунд
считается выигранным.
The player is given a random number, and he must answer 'yes' if the number
is even, and 'no' if it is odd. If the player answers correctly, the round
is considered won
Returns:
tuple[str, str]: Кортеж, содержащий вопрос в виде строки и правильный
ответ в виде строки.
tuple[str, str]: A tuple containing a question as a string and the
correct answer as a string
"""
number = get_random_number()
question = str(number)
Expand Down
23 changes: 12 additions & 11 deletions brain_games/games/gcd.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,33 @@

def find_gcd(a: int, b: int) -> int:
"""
Вычисляет наибольший общий делитель двух чисел
Calculates the largest common divisor of two numbers
Args:
a (int): Первое число.
b (int): Второе число.
a (int): First number
b (int): Second number
Returns:
int: Наибольший общий делитель двух чисел.
int: The largest common divisor of two numbers
"""
return math.gcd(a, b)


def get_number_and_gcd_status() -> tuple[str, str]:
"""
Проводит один раунд игры на нахождение НОД двух случайных чисел.
Conducts one round of the game to find the largest common divisor of two
random numbers
Игроку предлагается найти наибольший общий делитель двух случайных чисел,
которые не равны 1, и наименьший общий делитель которых не равен 1.
The player is asked to find the largest common divisor of two random numbers
that are not equal to 1, and the smallest common divisor of which is not
equal to 1
Если игрок отвечает правильно, игра продолжается, если нет - игра
завершается.
If the player answers correctly, the game continues, if not, the game ends
Returns:
tuple[str, str]: Кортеж, содержащий вопрос в виде строки и правильный
ответ в виде строки.
tuple[str, str]: A tuple containing a question as a string and the
correct answer as a string
"""
number_one, number_two = get_random_number(), get_random_number()
question = f"{number_one} {number_two}"
Expand Down
24 changes: 12 additions & 12 deletions brain_games/games/prime.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

def is_prime(number: int) -> bool:
"""
Проверяет, является ли число простым.
Если число делится на какое-либо число больше своего квадратного корня, то
другой делитель обязательно будет меньше квадратного корня
Checks if the number is prime.
If a number is divided by any number greater than its square root, then
the other divisor will necessarily be less than the square root
Args:
number (int): Целое число для проверки.
number (int): An integer to check
Returns:
bool: True, если число простое, иначе False.
bool: True if number is prime, else False.
"""

if number < 2:
Expand All @@ -26,17 +26,17 @@ def is_prime(number: int) -> bool:

def get_number_and_prime_status() -> tuple[str, str]:
"""
Проводит один раунд игры, в котором игрок должен угадать, является ли число
простым.
Conducts one round of the game in which the player must guess whether the
number is simple
Игроку задается случайное число, и он должен ответить 'yes', если число
простое, и 'no', если не является простым. Если игрок отвечает правильно,
раунд считается выигранным.
The player is given a random number and must answer 'yes' if the number
simple, and 'no' if it is not simple. If the player answers correctly,
the round is considered won
Returns:
tuple[str, str]: Кортеж, содержащий вопрос в виде строки и правильный
ответ в виде строки.
tuple[str, str]: A tuple containing a question in the form of a string
and the correct answer in the form of a string
"""
number = get_random_number()
question = str(number)
Expand Down
6 changes: 3 additions & 3 deletions brain_games/games/progression.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

def get_progression_and_missed_number() -> tuple[str, str]:
"""
Генерирует арифметическую прогрессию и скрывает один из ее элементов.
Generates an arithmetic progression and hides one of its elements
Returns:
tuple[str, str]: Кортеж, содержащий вопрос в виде строки и правильный
ответ в виде строки.
tuple[str, str]: A tuple containing a question as a string and the
correct answer as a string
"""
start = get_random_number(1, 100)
step = get_random_number(1, 40)
Expand Down

0 comments on commit 3143f11

Please sign in to comment.