Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes during Github review #71

Merged
merged 17 commits into from
Jan 14, 2025
Merged

Changes during Github review #71

merged 17 commits into from
Jan 14, 2025

Conversation

Asmoorr
Copy link
Contributor

@Asmoorr Asmoorr commented Jan 9, 2025

Summary of Changes:

  • Added docstrings to functions for better documentation and readability (e4f76a3, 5419201, e8c2ef8).
  • Improved return type for specific functions to match desired outputs (d8c8fe4).
  • Updated and optimized test structures and added new tests to enhance coverage (c0a88f4, 0f5ba79).
  • Renamed several filenames for consistency (842803b).
  • Translated some documentation and tests into Russian (539c56c, 33b7cee).
  • Cleaned up the project by removing unused directories and ignoring .idea files (cee2360, ffbd000, 0b54acc).

Key Features:

  • Improved code readability with detailed inline documentation.
  • Better test coverage with structured and meaningful test cases.
  • Removed unnecessary clutter from the repository, making it more maintainable.
  • Bilingual support in documentation and tests for English and Russian-speaking collaborators.

How to Test:

  1. Run the test suite to verify the updated tests and ensure that all cases pass successfully.
  2. Review the added docstrings and translations for accuracy.

Основные изменения:

  • Добавлены docstrings к функциям для улучшения документации и читаемости (e4f76a3, 5419201, e8c2ef8).
  • Обновлены возвращаемые значения в некоторых функциях для соответствия ожидаемым результатам (d8c8fe4).
  • Улучшена структура тестов, добавлены новые тесты для расширения покрытия (c0a88f4, 0f5ba79).
  • Переименованы некоторые файлы для обеспечения согласованности (842803b).
  • Переведена документация и некоторые тесты на русский язык (539c56c, 33b7cee).
  • Проведена очистка проекта: удалены лишние директории и добавлен .idea в .gitignore (cee2360, ffbd000, 0b54acc).

Основные особенности:

  • Улучшена читаемость кода благодаря подробной встроенной документации.
  • Расширено покрытие тестами, добавлены структурированные и значимые тестовые случаи.
  • Удалены ненужные файлы и директории, улучшена поддержка репозитория.
  • Билингвальная поддержка документации и тестов для англоговорящих и русскоязычных участников.

Как протестировать:

  1. Запустите тесты, чтобы проверить обновленные тестовые случаи и убедиться, что все успешно проходят.
  2. Просмотрите добавленные docstrings и переводы на предмет точности.

# Conflicts:
#	README.md
#	README_eng.md
#	tests/test_utils.py
#	tests/tests.py
Copy link
Collaborator

@tanyapole tanyapole left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in substance, good changes. need to fix the build

@tanyapole tanyapole merged commit e36fff3 into aimclub:main Jan 14, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants