Skip to content

refactor: clean up TODO comments in core library#1131

Open
zubeyralmaho wants to merge 1 commit intouber:masterfrom
zubeyralmaho:cleanup/remove-todos-from-core-lib
Open

refactor: clean up TODO comments in core library#1131
zubeyralmaho wants to merge 1 commit intouber:masterfrom
zubeyralmaho:cleanup/remove-todos-from-core-lib

Conversation

@zubeyralmaho
Copy link
Copy Markdown

  • directedEdge.c: Add proper error handling for cellToParent calls
  • h3api.h.in: Remove outdated release note from cellsToMultiPolygon docs
  • algos.c: Replace fuzzer-related TODOs with descriptive defensive comments
  • h3Index.c: Convert TODOs to issue reference and defensive notes
  • localij.c: Document known limitations for pentagon unfolding cases
  • vertexGraph.c: Update hash function performance note to NOTE
  • cellsToMultiPoly.c: Update edge iterator note to NOTE
  • polygon.c: Update polyfill refactoring note to NOTE

These changes improve code documentation by:

  1. Implementing proper error handling where TODOs indicated missing code
  2. Converting speculative TODOs into accurate NOTE comments
  3. Documenting known limitations instead of leaving unclear TODOs

No functional changes to the library behavior.

- directedEdge.c: Add proper error handling for cellToParent calls
- h3api.h.in: Remove outdated release note from cellsToMultiPolygon docs
- algos.c: Replace fuzzer-related TODOs with descriptive defensive comments
- h3Index.c: Convert TODOs to issue reference and defensive notes
- localij.c: Document known limitations for pentagon unfolding cases
- vertexGraph.c: Update hash function performance note to NOTE
- cellsToMultiPoly.c: Update edge iterator note to NOTE
- polygon.c: Update polyfill refactoring note to NOTE

These changes improve code documentation by:
1. Implementing proper error handling where TODOs indicated missing code
2. Converting speculative TODOs into accurate NOTE comments
3. Documenting known limitations instead of leaving unclear TODOs

No functional changes to the library behavior.
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 1, 2026

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants