Skip to content

Add doctests in all functions in basic_string.py #11374

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
Merged
merged 6 commits into from
Apr 20, 2024
Merged

Add doctests in all functions in basic_string.py #11374

merged 6 commits into from
Apr 20, 2024

Conversation

KelvinPuyam
Copy link
Contributor

@KelvinPuyam KelvinPuyam commented Apr 20, 2024 •
edited
Loading

Describe your change:

  • 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".

@KelvinPuyam
Copy link
Contributor Author

Requesting review: @cclauss

@algorithms-keeper algorithms-keeper bot added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Apr 20, 2024
@KelvinPuyam
Copy link
Contributor Author

KelvinPuyam commented Apr 20, 2024 •
edited
Loading

I reverted back to the original code. I added the doctests for all the functions. I also showed mutation in the mutate function doctest. So in conclusion I only added the doctests. I did not change the algorithm. Pls let me know if I should make any changes.

@KelvinPuyam KelvinPuyam requested a review from cclauss April 20, 2024 08:12
@cclauss cclauss enabled auto-merge (squash) April 20, 2024 10:41
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Apr 20, 2024
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed tests are failing Do not merge until tests pass labels Apr 20, 2024
cclauss
cclauss approved these changes Apr 20, 2024
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Rock and roll!!

@cclauss cclauss merged commit 4259348 into TheAlgorithms:master Apr 20, 2024
3 checks passed
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Apr 20, 2024
@KelvinPuyam KelvinPuyam deleted the add-doctests-basic-string branch April 20, 2024 10:53
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@KelvinPuyam @pre-commit-ci
@cclauss @sedatguzelsemme
Add doctests in all functions in basic_string.py (TheAlgorithms#11374)
876097a 
* Add doctests in all functions in basic_string.py

* Revert back to original basic_string.py

* Add doctest in basic_string.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update genetic_algorithm/basic_string.py

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
@isidroas isidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@KelvinPuyam @cclauss