Python icon indicating copy to clipboard operation
Python copied to clipboard

improve docstring for DDA algorithm

Open tanishka-sonawane opened this issue 4 weeks ago • 0 comments

Fixes #13905

Improves the DDA algorithm docstring by adding:

  • explanation of how the algorithm works
  • its main disadvantage
  • comparison with Bresenham algorithm
  • reference link for further reading

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.
  • [ yes ] Documentation change?

Checklist:

  • [ yes ] I have read CONTRIBUTING.md.
  • [ yes ] 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".

tanishka-sonawane avatar Dec 21 '25 20:12 tanishka-sonawane