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

Add DocTests to magicdiamondpattern.py #10135

Merged
merged 2 commits into from
Oct 9, 2023
Merged

Add DocTests to magicdiamondpattern.py #10135

merged 2 commits into from
Oct 9, 2023

Conversation

SaiHarshaK
Copy link
Contributor

@SaiHarshaK SaiHarshaK commented Oct 8, 2023 •
edited
Loading

Describe your change:

This PR adds DocTests to the functions in is_palindrome.py to increase its codecoverage from 0% to 93%.
Tested this change locally and can verify that they are passing.

Ref #9943

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • 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 Oct 8, 2023
@SaiHarshaK
Copy link
Contributor Author

@cclauss could you check this one too?

@SaiHarshaK SaiHarshaK mentioned this pull request Oct 9, 2023
Open
@cclauss
Copy link
Member

cclauss commented Oct 9, 2023

Tests first and then code changes after please.

Please avoid changing the tests and the code in a single pull request. It is much better to add tests in a single PR and make sure they pass with the current code. After the first PR lands, you can return and create a second PR that changes the code and changes the tests to match the code changes.

@cclauss cclauss enabled auto-merge (squash) October 9, 2023 12:16
@cclauss cclauss merged commit 876087b into TheAlgorithms:master Oct 9, 2023
3 checks passed
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 9, 2023
@SaiHarshaK
Copy link
Contributor Author

Will do that from next time, thanks

sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@SaiHarshaK @sedatguzelsemme
Add DocTests to magicdiamondpattern.py (TheAlgorithms#10135)
aa940a2 
* magicdiamondpattern doctest

* remove start part

---------

Co-authored-by: Harsha Kottapalli <[email protected]>
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
enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

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