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

Create digital differential analyzer_line.py #10929

Merged
merged 36 commits into from
Dec 31, 2024
Merged

Create digital differential analyzer_line.py #10929

merged 36 commits into from
Dec 31, 2024

Conversation

nababuddin
Copy link
Contributor

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

@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass labels Oct 25, 2023
tianyizheng02
tianyizheng02 requested changes Oct 26, 2023
View reviewed changes
graphics/DDA_line_drawing.py Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Please do not abbreviate "digital differential analyzer", as it's not clear to readers who aren't already familiar with the algorithm.
  2. The file name should be in all-lowercase.

nababuddin
nababuddin commented Oct 26, 2023
View reviewed changes
Copy link
Contributor Author

@nababuddin nababuddin left a comment

Choose a reason for hiding this comment

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

Thanks for the suggestion, made the changes

@algorithms-keeper algorithms-keeper bot added require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Oct 26, 2023
algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 26, 2023
View reviewed changes
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

graphics/digital_differential_analyzer_line_drawing.py Outdated
import matplotlib.pyplot as plt


def dda_line(x1, y1, x2, y2):
Copy link

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file graphics/digital_differential_analyzer_line_drawing.py, please provide doctest for the function dda_line

Please provide return type hint for the function: dda_line. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: x1

Please provide type hint for the parameter: y1

Please provide type hint for the parameter: x2

Please provide type hint for the parameter: y2

@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 26, 2023
algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 26, 2023
View reviewed changes
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

graphics/digital_differential_analyzer_line_drawing.py Outdated
import matplotlib.pyplot as plt


def dda_line(x1, y1, x2, y2):
Copy link

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file graphics/digital_differential_analyzer_line_drawing.py, please provide doctest for the function dda_line

Please provide return type hint for the function: dda_line. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: x1

Please provide type hint for the parameter: y1

Please provide type hint for the parameter: x2

Please provide type hint for the parameter: y2

nababuddin
nababuddin commented Oct 26, 2023
View reviewed changes
Copy link
Contributor Author

@nababuddin nababuddin left a comment

Choose a reason for hiding this comment

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

made the necessary changes

@nababuddin nababuddin changed the title Create DDA_line_drawing.py Create digital differential analyzer_line_drawing.py Oct 26, 2023
tianyizheng02
tianyizheng02 requested changes Oct 26, 2023
View reviewed changes
graphics/digital_differential_analyzer_line_drawing.py Outdated
import matplotlib.pyplot as plt


def dda_line(x1, y1, x2, y2):
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Like I said earlier, please do not abbreviate "digital differential analyzer".
  2. Like the algorithm-keeper bot said, please add type hints and doctests.

@algorithms-keeper algorithms-keeper bot removed require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Oct 27, 2023
nababuddin

This comment was marked as outdated.

Sign in to view

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 27, 2023
nababuddin
nababuddin commented Oct 27, 2023
View reviewed changes
Copy link
Contributor Author

@nababuddin nababuddin left a comment

Choose a reason for hiding this comment

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

I made the changes.

algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 28, 2023
View reviewed changes
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

graphics/digital_differential_analyzer_line.py Outdated Show resolved Hide resolved
nababuddin
nababuddin commented Oct 28, 2023
View reviewed changes
Copy link
Contributor Author

@nababuddin nababuddin left a comment

Choose a reason for hiding this comment

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

I have made the changes you requested.

@algorithms-keeper algorithms-keeper bot added the require tests Tests [doctest/unittest/pytest] are required label Oct 28, 2023
algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 28, 2023
View reviewed changes
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

graphics/digital_differential_analyzer_line.py Show resolved Hide resolved
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 28, 2023
@algorithms-keeper algorithms-keeper bot removed the require tests Tests [doctest/unittest/pytest] are required label Oct 28, 2023
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 28, 2023
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 28, 2023
nababuddin
nababuddin commented Oct 28, 2023
View reviewed changes
Copy link
Contributor Author

@nababuddin nababuddin left a comment

Choose a reason for hiding this comment

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

I think its all fixed now and ready to merge.

@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 Dec 31, 2024
@tianyizheng02 tianyizheng02 merged commit 91a22c2 into TheAlgorithms:master Dec 31, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@algorithms-keeper algorithms-keeper[bot] algorithms-keeper[bot] left review comments

@tianyizheng02 tianyizheng02 tianyizheng02 approved these changes

Assignees
No one assigned
Labels
awaiting reviews This PR is ready to be reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nababuddin @tianyizheng02