Reqnroll icon indicating copy to clipboard operation
Reqnroll copied to clipboard
verified publisher icon reqnroll

Add READMEs and XML documentation to all NuGet packages

Open 304NotModified opened this issue 5 months ago • 3 comments

🤔 What's changed?

  • Added readmes to all NuGet packages, with the help of Copilot. I reviewed all the readmes and edited most of them.
  • Added XML docs to the NuGet packages
  • Added NoWarn for "Missing XML comment for publicly visible type or member" (CS1591), otherwise there are many warnings.
  • Removed old <summary> from xunit3 package (was already removed for others) - see #766

See also validation results, the warning for the reqnroll pacakge is fine (will disable in the future)

image image

The Verify package has still some issues, that is out of scope here, see https://github.com/reqnroll/Reqnroll/issues/709

image

⚡️ What's your motivation?

Better documentation

🏷️ What kind of change is this?

  • :book: Documentation (improvements without changing code)

📋 Checklist:

  • [x] I have added an entry to the "[vNext]" section of the CHANGELOG, linking to this pull request & included my GitHub handle to the release contributors list.

304NotModified avatar Sep 17 '25 21:09 304NotModified

@gasparnagy It would be nice if we could include this for 3.1 :)

304NotModified avatar Sep 17 '25 23:09 304NotModified

@gasparnagy It would be nice if we could include this for 3.1 :)

Would be great. But let's wait for #812 to be finished first.

gasparnagy avatar Sep 18 '25 04:09 gasparnagy

@304NotModified #812 is merged. Do you see a chance you can update this until the end of this week?

gasparnagy avatar Sep 24 '25 12:09 gasparnagy