Skip to content

Fix: Improve docstrings and use ValueError in rec_linear_search#14626

Open
snehapriy958 wants to merge 1 commit intoTheAlgorithms:masterfrom
snehapriy958:fix-linear-search-doc-exception
Open

Fix: Improve docstrings and use ValueError in rec_linear_search#14626
snehapriy958 wants to merge 1 commit intoTheAlgorithms:masterfrom
snehapriy958:fix-linear-search-doc-exception

Conversation

@snehapriy958
Copy link
Copy Markdown

Describe your change:

Improved documentation and replaced a generic exception with a more specific ValueError in the recursive linear search implementation.

Changes

  • Improved docstring clarity and consistency
  • Replaced generic Exception with ValueError for invalid bounds

Why

  • More specific exception type improves code quality
  • Clearer documentation for users

Impact

  • No change in algorithm or behavior for valid inputs
  • 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 #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper Bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels May 4, 2026
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 enhancement This PR modified some existing files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant