update docs

[MatteoDelOmbra]

• Task version updated (x.x.0)
• CHANGELOG.md updated
• Solution builds
• Warnings resolved (if possible)
• Typos resolved
• Tests cover new code
• Description how to run tests locally added to README.md (if needed)
• All tests pass locally

---

Summary by CodeRabbit

• Documentation

  • Updated documentation to clarify the behavior and limitations of row count reporting during bulk insert operations.

• Chores

  • Released version 3.2.0.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f48394e0-b213-4727-920b-133c0f3e2d25

📥 Commits

Reviewing files that changed from the base of the PR and between c7191de and e22c612.

📒 Files selected for processing (3)

• Frends.MicrosoftSQL.BulkInsert/CHANGELOG.md
• Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert/Definitions/Result.cs
• Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert.csproj

---

Walkthrough

The Result.Count XML documentation is updated to specify that the value reflects row counts from SqlBulkCopy notifications, is approximate and rounded down to the nearest NotifyAfter interval, and is 0 when no notification fires. The NuGet package version is bumped from 3.1.0 to 3.2.0, and a matching changelog entry is added.

Changes

3.2.0 Documentation Update and Version Bump

Layer / File(s)	Summary
Result.Count XML doc, version bump, and changelog Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert/Definitions/Result.cs, Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert.csproj, Frends.MicrosoftSQL.BulkInsert/CHANGELOG.md	Result.Count XML docs now describe SqlBulkCopy notification-based approximate row count semantics and the 0 case; package version incremented to 3.2.0; changelog entry added for the release.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 A doc was fuzzy, now it's clear,
The count rounds down — no need to fear!
NotifyAfter sets the pace,
Zero means no notification's trace.
Version bumped, the changelog penned,
A tidy hop from start to end! ✨

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title 'update docs' is vague and generic, using a non-descriptive term that doesn't convey meaningful information about the specific documentation changes made.	Revise the title to be more specific, such as 'Update documentation for Result.Count property' or 'Bump version to 3.2.0 and update documentation', to clearly communicate the main change.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fspes-140

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}