You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: replace "coordinate" with "value" in XML doc comments and internal identifiers (#235)
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.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: petesramek <2333452+petesramek@users.noreply.github.com>
/// Provides extension methods for the <see cref="IPolylineEncoder{TValue, TPolyline}"/> interface to facilitate encoding geographic coordinates into polylines.
13
+
/// Provides extension methods for the <see cref="IPolylineEncoder{TValue, TPolyline}"/> interface to facilitate encoding values into polylines.
14
14
/// </summary>
15
15
publicstaticclassPolylineEncoderExtensions{
16
16
/// <summary>
17
17
/// Encodes an array of <typeparamref name="TValue"/> instances into an encoded polyline.
18
18
/// </summary>
19
-
/// <typeparam name="TValue">The type that represents a geographic coordinate to encode.</typeparam>
19
+
/// <typeparam name="TValue">The type that represents a value to encode.</typeparam>
20
20
/// <typeparam name="TPolyline">The type that represents the encoded polyline output.</typeparam>
21
21
/// <param name="encoder">
22
22
/// The <see cref="IPolylineEncoder{TValue, TPolyline}"/> instance used to perform the encoding operation.
@@ -25,7 +25,7 @@ public static class PolylineEncoderExtensions {
25
25
/// The array of <typeparamref name="TValue"/> objects to encode.
26
26
/// </param>
27
27
/// <returns>
28
-
/// A <typeparamref name="TPolyline"/> instance representing the encoded polyline for the provided coordinates.
28
+
/// A <typeparamref name="TPolyline"/> instance representing the encoded polyline for the provided values.
29
29
/// </returns>
30
30
/// <exception cref="ArgumentNullException">
31
31
/// Thrown when <paramref name="encoder"/> or <paramref name="values"/> is <see langword="null"/>.
0 commit comments