Skip to content

chore: replace "coordinate" with "value" in XML doc comments and internal identifiers#235

Merged
petesramek merged 2 commits intoextend-polylinealgorithm-multi-dimensional-supportfrom
copilot/update-xml-comments-and-replace-coordinate
Apr 13, 2026
Merged

chore: replace "coordinate" with "value" in XML doc comments and internal identifiers#235
petesramek merged 2 commits intoextend-polylinealgorithm-multi-dimensional-supportfrom
copilot/update-xml-comments-and-replace-coordinate

Conversation

Copy link
Copy Markdown

Copilot AI commented Apr 13, 2026

The codebase still used "coordinate" terminology throughout XML doc comments and internal identifiers, despite the API having been refactored to the generic TValue abstraction. This aligns all documentation and internal naming with the current design.

XML doc comments (16 files)

  • Replaced geographic coordinate(s)value(s) in <summary>, <typeparam>, <param>, and <returns> tags across all public and internal types (PolylineEncoder, PolylineDecoder, IPolylineEncoder, IPolylineDecoder, IPolylineFormatter, PolylineEncodingOptions, PolylineOptions, PolylineItemFactory, PolylineFormatter, FormatterBuilder, PolylineEncoderExtensions, PolylineEncoding, Defaults, ExceptionGuard, LogWarningExtensions, LogDebugExtensions)
  • Updated example pseudocode in IPolylineEncoder from Coordinate to Value type name

Internal identifiers

Before After
ThrowCoordinateValueOutOfRange ThrowValueOutOfRange
FormatCoordinateValueMustBeBetween FormatValueMustBeBetween
Defaults.Coordinate (nested class) Defaults.Value
coordinateIndex (log param) valueIndex
Log: "Decoded coordinate: ..." "Decoded value: ..."
Log: "Current coordinate is at index" "Current value is at index"

All renames are internal — no public API or method parameter names changed. Tests updated to match new identifiers and log message strings.

@petesramek petesramek marked this pull request as ready for review April 13, 2026 14:42
@petesramek petesramek self-requested a review as a code owner April 13, 2026 14:42
@petesramek petesramek merged commit 7dc6aae into extend-polylinealgorithm-multi-dimensional-support Apr 13, 2026
4 checks passed
@petesramek petesramek deleted the copilot/update-xml-comments-and-replace-coordinate branch April 13, 2026 14:42
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