Skip to content

Adding / Updating comments for all public APIs - #53

Merged
SteveWinward merged 5 commits into
mainfrom
copilot/update-missing-comments
Sep 2, 2026
Merged

Adding / Updating comments for all public APIs#53
SteveWinward merged 5 commits into
mainfrom
copilot/update-missing-comments

Conversation

Copilot AI commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Updates the library NuGet package version for the next patch release.

  • Package metadata
    • Set GoogleSheetsWrapper version to 2.0.27.

Copilot AI and others added 4 commits September 2, 2026 13:52
Co-authored-by: SteveWinward <2002602+SteveWinward@users.noreply.github.com>
Co-authored-by: SteveWinward <2002602+SteveWinward@users.noreply.github.com>
Co-authored-by: SteveWinward <2002602+SteveWinward@users.noreply.github.com>
Co-authored-by: SteveWinward <2002602+SteveWinward@users.noreply.github.com>
@SteveWinward SteveWinward changed the title Set NuGet package version to 2.0.27 Adding / Updated comments for all public APIs Sep 2, 2026
@SteveWinward SteveWinward changed the title Adding / Updated comments for all public APIs Adding / Updating comments for all public APIs Sep 2, 2026
@SteveWinward
SteveWinward marked this pull request as ready for review September 2, 2026 14:07
@SteveWinward
SteveWinward requested a lite review from Copilot September 2, 2026 14:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The updated documentation introduces mismatches with current behavior and the SheetRange.Equals implementations have confirmed null/type-safety bugs that should be fixed before release.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR primarily improves XML documentation across several public APIs in the GoogleSheetsWrapper library and bumps the NuGet package version for the next patch release.

Changes:

  • Updated/expanded XML doc comments for multiple public APIs to better describe behavior and parameters/returns.
  • Bumped GoogleSheetsWrapper package version from 2.0.26 to 2.0.27.
  • Minor doc wording cleanup (e.g., correcting “mulitlpe” → “multiple”).
File summaries
File Description
src/GoogleSheetsWrapper/Utils/PhoneNumberParsing.cs Updated method XML docs for phone-number normalization/conversion utilities.
src/GoogleSheetsWrapper/SheetRange.cs Updated XML docs for notation properties, constructors, and equality/hash-code methods.
src/GoogleSheetsWrapper/SheetHelper.cs Updated XML docs for initialization and various CRUD/helper operations.
src/GoogleSheetsWrapper/SheetFieldAttributeUtils.cs Updated XML docs for reflection-based attribute utilities.
src/GoogleSheetsWrapper/SheetExporter.cs Updated XML docs for CSV/Excel export helpers.
src/GoogleSheetsWrapper/GoogleSheetsWrapper.csproj Bumped package version to 2.0.27.
Review details

Suppressed comments (3)

src/GoogleSheetsWrapper/Utils/PhoneNumberParsing.cs:35

  • This doc describes converting an already-normalized phone number and returning the number "without its country code", but the implementation also strips "+1" and non-digits itself (and not necessarily only leading). The summary/returns should describe what the method actually does so callers know they can pass formatted input.
        /// <summary>
        /// Converts a normalized United States phone number to a numeric value.
        /// </summary>
        /// <param name="number">The phone number to convert.</param>
        /// <returns>The numeric phone number without its country code.</returns>

src/GoogleSheetsWrapper/SheetRange.cs:289

  • Equals(object obj) performs an unchecked cast to SheetRange, which can throw InvalidCastException for non-SheetRange inputs (and NullReferenceException indirectly). Override equality should return false for other types and nulls.
        public override bool Equals(object obj)
        {
            return Equals((SheetRange)obj);
        }

src/GoogleSheetsWrapper/SheetRange.cs:271

  • Equals(SheetRange other) dereferences other without a null check, so range.Equals((SheetRange)null) will throw a NullReferenceException instead of returning false (as expected by IEquatable<T> and many callers). Add a null guard before comparing fields.

This issue also appears on line 286 of the same file.

        public bool Equals(SheetRange other)
        {
            return
                A1Notation == other.A1Notation &&
                CanSupportA1Notation == other.CanSupportA1Notation &&
  • Files reviewed: 6/6 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/GoogleSheetsWrapper/Utils/PhoneNumberParsing.cs
Co-authored-by: SteveWinward <2002602+SteveWinward@users.noreply.github.com>
Copilot AI requested a review from SteveWinward September 2, 2026 14:25
@SteveWinward
SteveWinward merged commit ee9d405 into main Sep 2, 2026
4 checks passed
@SteveWinward
SteveWinward deleted the copilot/update-missing-comments branch September 2, 2026 14:30
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.

3 participants