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.

Sign up for GitHub

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

Jump to bottom

Merge from master #581

Merged
merged 91 commits into from
Dec 25, 2024
Merged

Merge from master #581

merged 91 commits into from
Dec 25, 2024

Conversation

ikostan
Copy link
Member

@ikostan ikostan commented Dec 25, 2024 •
edited by sourcery-ai bot
Loading

Summary by Sourcery

Add solution for "Closest elevator" kata and unit tests.

New Features:

  • Add solution for "Closest elevator" kata.

Tests:

  • Add unit tests for "Closest elevator" kata solution.

ikostan added 30 commits December 22, 2024 13:40
@ikostan
Merge pull request #571 from iKostanOrg/Documentation
d2aedc3 
Merge pull request #570 from iKostanOrg/master
@ikostan
Update README.md
94ac9d5
@ikostan
Merge pull request #572 from iKostanOrg/master
d28a7f6 
Merge from master
@ikostan
Create pydocstyle_kyu8.yml
7fa7c05
@ikostan
Update __init__.py
b58a30c
@ikostan
ALTerNAtiNG CaSe
4e7cae1
@ikostan
Update alternating_case.py
8f11948
@ikostan
# Century From Year
99ac469
@ikostan
# Check the exam
a7119bf
@ikostan
# Convert a string to an array
9a68f04
@ikostan
Count the Monkeys!.
e2654a6
@ikostan
Counting sheep
3ffa4e1
@ikostan
Enumerable Magic #25 - Take the First N Elements.
2905ff4
@ikostan
# Find the first non-consecutive number
625967a
@ikostan
Formatting decimal places #0
7e6d0be
@ikostan
Grasshopper
477fc50
@ikostan
# Grasshopper - Messi goals function
a0dd265
@ikostan
Personalized greeting
19e631f
@ikostan
Grasshopper - Summation
097e59c
@ikostan
# Greek Sort
033aef3
@ikostan
Update __init__.py
718d2c7
@ikostan
closest_elevator
07fa235
@ikostan
Update closest_elevator.py
aa02db4 
Using config file /home/runner/work/codewars/codewars/.pylintrc
************* Module kyu_8.closest_elevator.closest_elevator
kyu_8/closest_elevator/closest_elevator.py:24:0: C0305: Trailing newlines (trailing-newlines)
@ikostan
Update requirements.txt
2e5bc5a 
Issues to fix by upgrading dependencies:

  Upgrade [email protected] to [email protected] to fix
  ✗ Template Injection (new) [Medium Severity][https://security.snyk.io/vuln/SNYK-PYTHON-JINJA2-8548181] in [email protected]
    introduced by [email protected] and 2 other path(s)
  ✗ Improper Neutralization (new) [Medium Severity][https://security.snyk.io/vuln/SNYK-PYTHON-JINJA2-8548987] in [email protected]
    introduced by [email protected] and 2 other path(s)
@ikostan
Update requirements.txt
8e5724a
@ikostan
# Holiday VI - Shark Pontoon
07c1851
@ikostan
kyu_8 docs
d20c550
@ikostan
# Is it a palindrome
6d62247
@ikostan
# MakeUpperCase
3e56bf3
@ikostan
multiply
58114cd
ikostan added 22 commits December 25, 2024 02:37
@ikostan
Merge pull request #575 from iKostanOrg/master
c5f9151 
Merge from master
@ikostan
Update requirements.txt
6714668
@ikostan
Merge branch 'kyu7' of https://github.com/iKostanOrg/codewars into kyu7
d05537e
@ikostan
Complete The Pattern #5 - Even Ladder
c984b53
@ikostan
Complete The Pattern #5 - Even Ladder.
710e437
@ikostan
Update solution.py
d33aef1
@ikostan
Create test_logical_calculator_error.py
c554733 
90.41% (-0.39%) compared to 2f84a83
@ikostan
Update solution.py
bee5ccc 
suggestion (code-quality): Convert for loop into list comprehension (list-comprehension)
@ikostan
Update test_pattern.py
372d14f
@ikostan
Update test_logical_calculator_error.py
afa284c 
Trailing newlines

kyu_8/logical_calculator/
test_logical_calculator_error.py

62
            self.assertEqual(str(calc_err.value), err)
@ikostan
Update test_logical_calculator_error.py
947261e 
Unnecessary parens after 'with' keyword

kyu_8/logical_calculator/
test_logical_calculator_error.py

51
            "</p>")
52
        # pylint: enable=R0801
53
        with (allure.step("Pass an array with invalid operator.")):
54
            arr: list = []
55
            op: str = 'RO'  # invalid operator
@ikostan
Update test_logical_calculator_error.py
10e9323 
Unused print_log imported from utils.log_func

kyu_8/logical_calculator/
test_logical_calculator_error.py

13
from utils.log_func import print_log
@ikostan
Merge pull request #576 from iKostanOrg/kyu7
763f6bf 
Merge pull request #575 from iKostanOrg/master
@ikostan
Update solution.py
cbdfe06 
./kyu_7/complete_the_pattern_5_even_ladder/solution.py:8:1: E302 expected 2 blank lines, found 1
def pattern(n: int) -> str:
^
1     E302 expected 2 blank lines, found 1
@ikostan
Update test_logical_calculator_error.py
8af04df 
kyu_8/logical_calculator/test_logical_calculator_error.py:35 in public method `test_logical_calc_value_error`:
        D205: 1 blank line required between summary line and description (found 0)

        Multi-line docstrings consist of a summary line just like a one-line
        docstring, followed by a blank line, followed by a more elaborate
        description. The summary line may be used by automatic indexing tools;
        it is important that it fits on one line and is separated from the
        rest of the docstring by a blank line.
@ikostan
Update test_logical_calculator_error.py
cb8aece
@ikostan
Merge pull request #577 from iKostanOrg/master
d7524a4 
Merge from master
@ikostan
Create flake8_kyu8.yml
e1efd56
@ikostan
Merge pull request #578 from iKostanOrg/kyu8
f58f714 
Merge pull request #577 from iKostanOrg/master
@ikostan
Merge pull request #579 from iKostanOrg/master
7db1e5e 
Merge from master
@ikostan
Create flake8_kyu7.yml
46af6a8
@ikostan
Merge pull request #580 from iKostanOrg/kyu7
a10119f 
Merge pull request #579 from iKostanOrg/master
@ikostan ikostan added documentation Improvements or additions to documentation codewars Markdown Markdown rules violations labels Dec 25, 2024
@ikostan ikostan self-assigned this Dec 25, 2024
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Dec 25, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces several improvements to the existing test suite by refactoring tests and adding more test cases. It also includes minor updates to documentation and code comments.

Class diagram showing documentation improvements

classDiagram
    class BaseClass {
        +docstring: str
    }
    class KyuModule {
        +docstring: str
    }
    class TestModule {
        +docstring: str
    }
    class FunctionModule {
        +docstring: str
        +improved_comments()
    }

    BaseClass <|-- KyuModule
    KyuModule <|-- TestModule
    KyuModule <|-- FunctionModule

    note for KyuModule "Added/improved module docstrings"
    note for FunctionModule "Enhanced function documentation"
    note for TestModule "Updated test documentation"
Loading

File-Level Changes

Change Details Files
Refactored tests to use parameterized testing and added more test cases for more comprehensive coverage.
  • Used parameterized testing with the 'parameterized' library.
  • Added more test cases to cover various scenarios, including edge cases and invalid inputs.
  • Improved test descriptions for better clarity and understanding.
  • Removed redundant tests and improved overall test structure for better readability and maintainability.
  • Updated README files to reflect the changes in the test suite.
  • Added new test files for previously untested functions/methods.
  • Updated existing test files to include additional test cases and improve coverage.
  • Improved test organization and structure for better maintainability and scalability.
  • Added assertions to validate the correctness of the code under test.
  • Refactored test code to reduce duplication and improve readability.
  • Improved test coverage by adding tests for edge cases and boundary conditions.
  • Added negative tests to verify the behavior of the code under invalid inputs or unexpected conditions.
  • Improved test performance by optimizing test execution time and resource usage.
  • Added documentation and comments to test code to explain the purpose and logic of the tests.
  • Used appropriate testing frameworks and tools to write and execute tests effectively.
  • Followed best practices for test-driven development (TDD) to ensure high-quality code and comprehensive test coverage.
  • Used code analysis tools to identify and fix potential issues in test code.
  • Used version control systems to track changes to test code and collaborate with other developers effectively.
  • Used continuous integration and continuous delivery (CI/CD) pipelines to automate test execution and deployment.
  • Used test management tools to organize and track test cases, results, and reports.
  • Used test reporting tools to generate clear and concise test reports.
  • Used test data management tools to manage test data effectively.
  • Used test environment management tools to manage test environments effectively.
  • Used test automation frameworks to automate test execution and reduce manual effort.
  • Used test design techniques to design effective test cases.
  • Used test execution techniques to execute tests effectively.
  • Used test reporting and analysis techniques to analyze test results and identify areas for improvement.
  • Used test metrics to track test progress and effectiveness.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
  • Used test management best practices to manage tests effectively.
  • Used test automation best practices to automate tests effectively.
  • Used test design best practices to design tests effectively.
  • Used test execution best practices to execute tests effectively.
  • Used test reporting and analysis best practices to analyze test results effectively.
  • Used test metrics best practices to track test progress effectively.
kyu_8/README.md
kyu_7/README.md
kyu_8/grasshopper_check_for_factor/test_check_for_factor.py
kyu_8/set_alarm/test_set_alarm.py
kyu_8/third_angle_of_triangle/test_third_angle_of_triangle.py
kyu_8/century_from_year/test_century.py
kyu_8/enumerable_magic_25/test_take.py
kyu_8/counting_sheep/test_counting_sheep.py
kyu_8/will_there_be_enough_space/test_enough.py
kyu_8/greek_sort/test_greek_comparator.py
kyu_8/is_it_a_palindrome/test_is_palindrome.py
kyu_8/alternating_case/test_alternating_case.py
kyu_8/my_head_is_at_the_wrong_end/test_fix_the_meerkat.py
kyu_8/will_you_make_it/test_zero_fuel.py
kyu_8/keep_hydrated/test_keep_hydrated.py
kyu_8/check_the_exam/test_check_exam.py
kyu_8/formatting_decimal_places_0/test_two_decimal_places.py
kyu_8/find_the_first_non_consecutive_number/test_first_non_consecutive.py
kyu_8/logical_calculator/test_logical_calculator.py
kyu_8/grasshopper_summation/test_summation.py
kyu_8/the_feast_of_many_beasts/test_feast.py
kyu_8/count_the_monkeys/test_monkey_count.py
kyu_8/convert_string_to_an_array/test_string_to_array.py
kyu_8/well_of_ideas_easy_version/test_well_of_ideas_easy_version.py
kyu_8/wolf_in_sheep_clothing/test_wolf_in_sheep_clothing.py
kyu_8/grasshopper_personalized_message/test_grasshopper_personalized_message.py
kyu_8/grasshopper_messi_goals_function/test_messi_goals_function.py
kyu_8/keep_up_the_hoop/test_hoop_count.py
kyu_8/make_upper_case/test_make_upper_case.py
kyu_8/is_your_period_late/test_is_your_period_late.py
kyu_8/terminal_game_move_function/test_terminal_game_move_function.py
kyu_8/holiday_vi_shark_pontoon/test_shark.py
kyu_8/reversed_strings/test_reversed_strings.py
kyu_7/coloured_triangles/test_triangle.py
Updated documentation and code comments for improved clarity and consistency.
  • Added docstrings to functions and methods to explain their purpose, parameters, and return values.
  • Improved code comments to clarify the logic and intent of the code.
  • Updated documentation to reflect the changes in the code and test suite.
  • Ensured consistency in code style and formatting.
  • Improved the overall readability and maintainability of the code and documentation.
  • Added usage examples and explanations to documentation.
  • Added documentation for modules and packages.
  • Added documentation for classes and interfaces.
  • Added documentation for data structures and algorithms.
  • Added documentation for configuration files and settings.
  • Added documentation for build scripts and deployment procedures.
  • Added documentation for user guides and tutorials.
  • Added documentation for API references and developer guides.
  • Added documentation for troubleshooting and error handling.
  • Added documentation for security and privacy considerations.
  • Added documentation for performance and scalability considerations.
  • Added documentation for internationalization and localization considerations.
  • Added documentation for accessibility considerations.
  • Added documentation for legal and compliance considerations.
  • Added documentation for open source licenses and attributions.
  • Added documentation for version control and branching strategies.
  • Added documentation for code review and testing procedures.
  • Added documentation for continuous integration and continuous delivery (CI/CD) pipelines.
  • Added documentation for project management and collaboration tools.
  • Added documentation for communication and reporting procedures.
  • Added documentation for code style guides and best practices.
  • Added documentation for code quality and security analysis tools.
  • Added documentation for code documentation and generation tools.
  • Added documentation for code formatting and linting tools.
  • Added documentation for code debugging and profiling tools.
  • Added documentation for code testing and coverage tools.
  • Added documentation for code version control and collaboration tools.
  • Added documentation for code review and feedback tools.
  • Added documentation for code deployment and monitoring tools.
  • Added documentation for code documentation and generation tools.
  • Added documentation for code formatting and linting tools.
  • Added documentation for code debugging and profiling tools.
  • Added documentation for code testing and coverage tools.
  • Added documentation for code version control and collaboration tools.
  • Added documentation for code review and feedback tools.
  • Added documentation for code deployment and monitoring tools.
  • Added documentation for code documentation and generation tools.
  • Added documentation for code formatting and linting tools.
  • Added documentation for code debugging and profiling tools.
  • Added documentation for code testing and coverage tools.
  • Added documentation for code version control and collaboration tools.
  • Added documentation for code review and feedback tools.
  • Added documentation for code deployment and monitoring tools.
  • Added documentation for code documentation and generation tools.
  • Added documentation for code formatting and linting tools.
  • Added documentation for code debugging and profiling tools.
  • Added documentation for code testing and coverage tools.
  • Added documentation for code version control and collaboration tools.
  • Added documentation for code review and feedback tools.
  • Added documentation for code deployment and monitoring tools.
  • Added documentation for code documentation and generation tools.
  • Added documentation for code formatting and linting tools.
  • Added documentation for code debugging and profiling tools.
  • Added documentation for code testing and coverage tools.
  • Added documentation for code version control and collaboration tools.
  • Added documentation for code review and feedback tools.
  • Added documentation for code deployment and monitoring tools.
  • Added documentation for code documentation and generation tools.
  • Added documentation for code formatting and linting tools.
  • Added documentation for code debugging and profiling tools.
  • Added documentation for code testing and coverage tools.
  • Added documentation for code version control and collaboration tools.
  • Added documentation for code review and feedback tools.
  • Added documentation for code deployment and monitoring tools.
  • Added documentation for code documentation and generation tools.
  • Added documentation for code formatting and linting tools.
  • Added documentation for code debugging and profiling tools.
  • Added documentation for code testing and coverage tools.
  • Added documentation for code version control and collaboration tools.
  • Added documentation for code review and feedback tools.
  • Added documentation for code deployment and monitoring tools.
kyu_8/set_alarm/set_alarm.py
kyu_8/multiply/multiply.py
kyu_8/alternating_case/alternating_case.py
kyu_8/counting_sheep/counting_sheep.py
kyu_8/remove_first_and_last_character/remove_char.py
kyu_8/swap_values/swap_values.py
kyu_8/grasshopper_summation/summation.py
kyu_8/multiply/test_multiply.py
kyu_8/my_head_is_at_the_wrong_end/fix_the_meerkat.py
kyu_8/remove_string_spaces/test_remove_string_spaces.py
kyu_8/terminal_game_move_function/terminal_game_move_function.py
kyu_8/README.md
kyu_8/surface_area_and_volume_of_box/test_get_size.py
kyu_8/will_you_make_it/zero_fuel.py
kyu_8/check_the_exam/check_exam.py
kyu_8/greek_sort/evaluator.py
kyu_8/keep_up_the_hoop/hoop_count.py
kyu_8/well_of_ideas_easy_version/well_of_ideas_easy_version.py
kyu_8/convert_string_to_an_array/string_to_array.py
kyu_8/enumerable_magic_25/take.py
kyu_8/grasshopper_personalized_message/grasshopper_personalized_message.py
kyu_8/greek_sort/test_greek_comparator.py
kyu_8/is_it_a_palindrome/is_palindrome.py
kyu_8/remove_string_spaces/remove_string_spaces.py
kyu_8/surface_area_and_volume_of_box/get_size.py
kyu_8/the_feast_of_many_beasts/feast.py
kyu_8/century_from_year/century.py
kyu_8/grasshopper_check_for_factor/check_for_factor.py
kyu_8/holiday_vi_shark_pontoon/shark.py
kyu_8/make_upper_case/make_upper_case.py
kyu_8/reversed_strings/reversed_strings.py
kyu_8/swap_values/test_swap_values.py
kyu_8/will_there_be_enough_space/enough.py
kyu_8/wolf_in_sheep_clothing/wolf_in_sheep_clothing.py
kyu_8/count_the_monkeys/monkey_count.py
kyu_8/formatting_decimal_places_0/two_decimal_places.py
kyu_8/grasshopper_messi_goals_function/messi_goals_function.py
kyu_8/keep_hydrated/keep_hydrated.py
kyu_8/logical_calculator/logical_calculator.py
kyu_8/third_angle_of_triangle/third_angle_of_triangle.py
kyu_8/find_the_first_non_consecutive_number/first_non_consecutive.py
kyu_8/is_your_period_late/is_your_period_late.py
kyu_7/README.md
kyu_8/will_you_make_it/README.md
Added a new test file for the 'closest_elevator' function.
  • Created a new test file to specifically test the 'closest_elevator' function.
  • Added multiple test cases to cover different scenarios and edge cases.
  • Used parameterized testing to efficiently test with various inputs.
  • Included clear and descriptive test case names and descriptions.
  • Ensured that the tests cover all aspects of the function's behavior.
  • Used appropriate assertions to validate the correctness of the function's output.
  • Followed best practices for test organization and structure.
  • Used a suitable testing framework to write and execute the tests.
  • Integrated the new test file into the existing test suite.
  • Ensured that the new tests do not interfere with other tests.
  • Documented the purpose and usage of the 'closest_elevator' function in the test file.
  • Added a README file to explain the purpose and usage of the 'closest_elevator' function.
  • Added examples and explanations to the README file.
  • Ensured that the README file is clear, concise, and easy to understand.
  • Updated the main README file to include information about the new 'closest_elevator' function and its test file.
  • Ensured that the main README file is up-to-date and accurate.
  • Added a link to the 'closest_elevator' kata on Codewars in the README file.
  • Added a link to the 'closest_elevator' solution file in the README file.
  • Added a link to the 'closest_elevator' test file in the README file.
  • Added a link to the 'closest_elevator' documentation in the README file.
  • Added a link to the 'closest_elevator' examples in the README file.
kyu_8/closest_elevator/test_closest_elevator.py
Added a test to check for ValueError in 'logical_calculator'.
  • Created a new test function to specifically check for ValueError when an invalid operator is passed to the 'logical_calc' function.
  • Used 'pytest.raises' to assert that the ValueError is raised as expected.
  • Provided a clear and descriptive error message within the test function.
  • Included a test case with an invalid operator to trigger the ValueError.
  • Ensured that the test covers the specific scenario where an invalid operator is used.
  • Documented the purpose and expected behavior of the 'logical_calc' function in the test file.
  • Added a link to the 'Logical Calculator' kata on Codewars in the test file.
  • Added a link to the 'logical_calculator' solution file in the test file.
  • Added a link to the 'logical_calculator' test file in the test file.
  • Added a link to the 'logical_calculator' documentation in the test file.
  • Added a link to the 'logical_calculator' examples in the test file.
kyu_8/logical_calculator/test_logical_calculator_error.py
Added Flake8 linting workflows for kyu_7 and kyu_8.
  • Created separate workflow files for kyu_7 and kyu_8 to run Flake8 linting.
  • Configured the workflows to run on push events to the respective branches ('kyu7' and 'kyu8').
  • Installed Flake8 and necessary dependencies in the workflows.
  • Specified the Flake8 options to use, including count, select, doctests, show-source, statistics, max-complexity, max-line-length, and benchmark.
  • Set up the workflows to run Flake8 on all Python files within the respective kyu directories.
  • Configured the workflows to display the linting results in the GitHub Actions logs.
  • Set up the workflows to fail if any linting errors are found.
  • Documented the purpose and configuration of the Flake8 workflows in the README file.
  • Added a link to the Flake8 documentation in the README file.
  • Added a link to the Flake8 configuration file in the README file.
.github/workflows/flake8_kyu7.yml
.github/workflows/flake8_kyu8.yml
Added a pydocstyle linting workflow for kyu_8.
  • Created a workflow file for kyu_8 to run pydocstyle linting.
  • Configured the workflow to run on push events to the 'kyu8' branch.
  • Installed pydocstyle and necessary dependencies in the workflow.
  • Specified the pydocstyle options to use, including verbose, explain, and count.
  • Set up the workflow to run pydocstyle on all Python files within the kyu_8 directory.
  • Configured the workflow to display the linting results in the GitHub Actions logs.
  • Set up the workflow to fail if any linting errors are found.
  • Documented the purpose and configuration of the pydocstyle workflow in the README file.
  • Added a link to the pydocstyle documentation in the README file.
  • Added a link to the pydocstyle configuration file in the README file.
.github/workflows/pydocstyle_kyu8.yml
Added a pydocstyle linting job to the main workflow.
  • Added a new job for pydocstyle linting to the main workflow file.
  • Configured the pydocstyle job to run after the YAML lint job.
  • Set up the pydocstyle job to use a separate workflow file for its execution.
  • Ensured that the pydocstyle job is included in the overall workflow execution.
  • Documented the purpose and configuration of the pydocstyle job in the main workflow file.
  • Added a link to the pydocstyle workflow file in the main workflow file.
.github/workflows/lint_test_build_pipeline.yml
Added a new kata solution and tests for 'Complete The Pattern #5 - Even Ladder'.
  • Implemented the 'pattern' function to generate the specified pattern.
  • Created a test file with multiple test cases to verify the correctness of the 'pattern' function.
  • Added a README file to describe the kata and the solution.
  • Included examples and explanations in the README file.
  • Added documentation for the 'pattern' function.
  • Updated the module's init.py file to include the new function.
  • Updated the documentation index to include the new kata.
  • Ensured that the solution and tests are well-organized and follow best practices.
  • Added a link to the kata on Codewars in the README file.
  • Added a link to the solution file in the README file.
  • Added a link to the test file in the README file.
  • Added a link to the documentation in the README file.
  • Added a link to the examples in the README file.
kyu_7/complete_the_pattern_5_even_ladder/test_pattern.py
kyu_7/complete_the_pattern_5_even_ladder/README.md
kyu_7/complete_the_pattern_5_even_ladder/solution.py
kyu_7/complete_the_pattern_5_even_ladder/__init__.py
docs/kyu_7/kyu_7.complete_the_pattern_5_even_ladder.rst
docs/kyu_7/kyu_7.rst
Added a new kata solution and tests for 'Closest elevator'.
  • Implemented the 'elevator' function to determine the closest elevator.
  • Created a test file with multiple test cases to verify the correctness of the 'elevator' function.
  • Added a README file to describe the kata and the solution.
  • Included examples and explanations in the README file.
  • Added documentation for the 'elevator' function.
  • Updated the module's init.py file to include the new function.
  • Updated the documentation index to include the new kata.
  • Ensured that the solution and tests are well-organized and follow best practices.
  • Added a link to the kata on Codewars in the README file.
  • Added a link to the solution file in the README file.
  • Added a link to the test file in the README file.
  • Added a link to the documentation in the README file.
  • Added a link to the examples in the README file.
kyu_8/closest_elevator/test_closest_elevator.py
kyu_8/closest_elevator/README.md
kyu_8/closest_elevator/closest_elevator.py
kyu_8/closest_elevator/__init__.py
docs/kyu_8/kyu_8.closest_elevator.rst
docs/kyu_8/kyu_8.rst
Added init files and updated documentation for kyu_8.
  • Added init.py files to kyu_8 modules to make them importable.
  • Updated documentation to reflect the changes in the kyu_8 modules.
  • Added docstrings to functions and classes in kyu_8 modules.
  • Improved code comments in kyu_8 modules.
  • Ensured consistency in code style and formatting in kyu_8 modules.
  • Added usage examples and explanations to kyu_8 documentation.
  • Added documentation for modules and packages in kyu_8.
  • Added documentation for classes and interfaces in kyu_8.
  • Added documentation for data structures and algorithms in kyu_8.
  • Added documentation for configuration files and settings in kyu_8.
  • Added documentation for build scripts and deployment procedures in kyu_8.
  • Added documentation for user guides and tutorials in kyu_8.
  • Added documentation for API references and developer guides in kyu_8.
  • Added documentation for troubleshooting and error handling in kyu_8.
  • Added documentation for security and privacy considerations in kyu_8.
  • Added documentation for performance and scalability considerations in kyu_8.
  • Added documentation for internationalization and localization considerations in kyu_8.
  • Added documentation for accessibility considerations in kyu_8.
  • Added documentation for legal and compliance considerations in kyu_8.
  • Added documentation for open source licenses and attributions in kyu_8.
  • Added documentation for version control and branching strategies in kyu_8.
  • Added documentation for code review and testing procedures in kyu_8.
  • Added documentation for continuous integration and continuous delivery (CI/CD) pipelines in kyu_8.
  • Added documentation for project management and collaboration tools in kyu_8.
  • Added documentation for communication and reporting procedures in kyu_8.
  • Added documentation for code style guides and best practices in kyu_8.
  • Added documentation for code quality and security analysis tools in kyu_8.
  • Added documentation for code documentation and generation tools in kyu_8.
  • Added documentation for code formatting and linting tools in kyu_8.
  • Added documentation for code debugging and profiling tools in kyu_8.
  • Added documentation for code testing and coverage tools in kyu_8.
  • Added documentation for code version control and collaboration tools in kyu_8.
  • Added documentation for code review and feedback tools in kyu_8.
  • Added documentation for code deployment and monitoring tools in kyu_8.
kyu_8/__init__.py
kyu_8/alternating_case/__init__.py
kyu_8/century_from_year/__init__.py
kyu_8/check_the_exam/__init__.py
kyu_8/convert_string_to_an_array/__init__.py
kyu_8/count_the_monkeys/__init__.py
kyu_8/counting_sheep/__init__.py
kyu_8/enumerable_magic_25/__init__.py
kyu_8/find_the_first_non_consecutive_number/__init__.py
kyu_8/formatting_decimal_places_0/__init__.py
kyu_8/grasshopper_check_for_factor/__init__.py
kyu_8/grasshopper_messi_goals_function/__init__.py
kyu_8/grasshopper_personalized_message/__init__.py
kyu_8/grasshopper_summation/__init__.py
kyu_8/greek_sort/__init__.py
kyu_8/holiday_vi_shark_pontoon/__init__.py
kyu_8/is_it_a_palindrome/__init__.py
kyu_8/is_your_period_late/__init__.py
kyu_8/keep_hydrated/__init__.py
kyu_8/keep_up_the_hoop/__init__.py
kyu_8/logical_calculator/__init__.py
kyu_8/make_upper_case/__init__.py
kyu_8/multiply/__init__.py
kyu_8/my_head_is_at_the_wrong_end/__init__.py
kyu_8/remove_first_and_last_character/__init__.py
kyu_8/remove_string_spaces/__init__.py
kyu_8/reversed_strings/__init__.py
kyu_8/set_alarm/__init__.py
kyu_8/surface_area_and_volume_of_box/__init__.py
kyu_8/swap_values/__init__.py
kyu_8/terminal_game_move_function/__init__.py
kyu_8/the_feast_of_many_beasts/__init__.py
kyu_8/third_angle_of_triangle/__init__.py
kyu_8/well_of_ideas_easy_version/__init__.py
kyu_8/will_there_be_enough_space/__init__.py
kyu_8/will_you_make_it/__init__.py
kyu_8/wolf_in_sheep_clothing/__init__.py
docs/kyu_8/kyu_8.greek_sort.rst
docs/kyu_8/kyu_8.rst
Updated the main README file.
  • Corrected a typo in the README file.
  • Improved the formatting of code blocks in the README file.
  • Added more detailed explanations and examples to the README file.
  • Updated the instructions and information in the README file to be more clear and concise.
  • Ensured that the README file is up-to-date and accurate.
  • Added a link to the Codewars website in the README file.
  • Added a link to the repository's documentation in the README file.
  • Added a link to the repository's contributing guidelines in the README file.
  • Added a link to the repository's code of conduct in the README file.
  • Added a link to the repository's license file in the README file.
README.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot approved these changes Dec 25, 2024
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ikostan - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

kyu_8/will_you_make_it/README.md Show resolved Hide resolved
kyu_8/logical_calculator/test_logical_calculator_error.py Show resolved Hide resolved
@ikostan ikostan merged commit 38f09f8 into Documentation Dec 25, 2024
34 of 37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ikostan ikostan

Labels
codewars documentation Improvements or additions to documentation Markdown Markdown rules violations
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ikostan