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

Add doctests for sum_of_arithmetic_series function #12285

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

harshgupta257
Copy link

Describe your change:

I added comprehensive doctests to the sum_of_arithmetic_series function to ensure its reliability and to cover a range of use cases, including:

  1. Basic Functionality:

    • Added tests for typical arithmetic progression (AP) series, verifying the correct sum for series with common examples.
  2. Edge Cases:

    • Included tests for edge cases, such as a series with only one term or a series with zero difference between terms (i.e., where all terms are the same).
  3. Error Handling:

    • Added tests for error cases, where invalid inputs, such as a non-positive number of terms (n <= 0), would raise an error. This verifies that the function properly handles and raises exceptions as expected.

These doctests provide users with clear examples of how the function behaves with different inputs, and they help catch errors during automated testing, improving the function's robustness.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes Improve our test coverage #9943".

@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Oct 25, 2024
Copy link
Author

@harshgupta257 harshgupta257 left a comment

Choose a reason for hiding this comment

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

good to do contibute

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting reviews This PR is ready to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve our test coverage
1 participant