Skip to content

docs(graphics): improve DDA algorithm docstring explanation#14290

Open
nafeesath-tp wants to merge 1 commit intoTheAlgorithms:masterfrom
nafeesath-tp:improve-dda-docstring
Open

docs(graphics): improve DDA algorithm docstring explanation#14290
nafeesath-tp wants to merge 1 commit intoTheAlgorithms:masterfrom
nafeesath-tp:improve-dda-docstring

Conversation

@nafeesath-tp
Copy link

Describe your change:

Improved the docstring for the Digital Differential Analyzer (DDA)
line drawing algorithm to provide better educational context.

Added:

  • Explanation of algorithm principle
  • Advantages and disadvantages
  • Reference link for further learning

Closes #13905

  • 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:

  • [x ] I have read CONTRIBUTING.md.
  • [x ] 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.
  • [x ] 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 the tests are failing Do not merge until tests pass label Feb 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tests are failing Do not merge until tests pass

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Suggestion: Improve docstring for DDA algorithm

1 participant