Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump SauceControl.InheritDoc from 1.3.0 to 2.0.1 in /src #149

Merged
merged 1 commit into from
Apr 29, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Apr 26, 2024

Bumps SauceControl.InheritDoc from 1.3.0 to 2.0.1.

Release notes

Sourced from SauceControl.InheritDoc's releases.

v2.0.1

Fixes

  • Fixed an issue that caused cref links on fields (and enum members) to not resolve if they referred to external types/docs. Thanks to @​adaskos-signal for reporting this one. #14

v2.0.0

Breaking Changes

  • Starting with v2.0, InheritDoc requires MSBuild 16.0 or newer. The required version is included with Visual Studio 2019 or later, or any currently supported version of the .NET SDK.

Fixes

  • Fixed an issue that prevented the InheritDoc MSBuild task from being skipped in incremental builds when the compiler's input/output was unchanged. Previously, the input to the task was modified by the task's execution, meaning it would always evaluate as newer than the output. Thanks to @​chm-tm for identifying and fixing this #13.
  • Fixed an issue that allowed InheritDoc to run during design-time builds when InheritDocEnabled was explicitly set to true in a consuming project #10.

C# Primary Constructor Improvements

  • InheritDoc now identifies primary constructors by matching documentation between a type and its constructor, and applies fixups to each of the documentation copies.
    • Constructor documentation will now be inherited from a base constructor if present, allowing constructor param elements to be inherited.
    • param elements will be removed from the type's documentation when they are meant to apply to the constructor.

v1.4.0

  • For .NET Standard 2.0 targets, a replacement netstandard.xml file is included in this package, meaning the previous workaround for the malformed docs shipped with the ref pack (dotnet/standard#1527) is no longer necessary.
  • Fixed a possible NullReferenceException when an inheritdoc comment was used on an interface with no base.
  • Warnings will no longer be emitted for types/members in generated code (anything marked with [GeneratedCode] or [CompilerGenerated]). saucecontrol/InheritDoc#11
  • Warnings will no longer be emitted for automatically inserted docs for explicit interface implementations with no base docs.
  • When using C# Primary Constructors, warnings will not be emitted when the constructor does not have a base with documentation. In this case, constructor documentation will be inherited following the rules for the declaring type.
  • typeparamrefs inhereted in closed generic types will now be replaced with see references to the concrete type used.
Commits
  • e268da7 v2.0.1
  • d4ddea5 follow field crefs to reference docs
  • 197ec1f update dependencies, tidying
  • e8ce562 v2.0
  • 6e5438b improve handling of primary constructors
  • ee2e9f2 require MSBuild 16 or greater, bump version
  • 4c4d760 always skip InheritDoc for design-time and live unit testing builds
  • 5ba7079 allow InheritDocTask to be skipped on incremental build
  • 5b6693b v1.4.0
  • d43b5b5 handle inheritance with primary constructors
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [SauceControl.InheritDoc](https://github.com/saucecontrol/InheritDoc) from 1.3.0 to 2.0.1.
- [Release notes](https://github.com/saucecontrol/InheritDoc/releases)
- [Commits](saucecontrol/InheritDoc@v1.3.0...v2.0.1)

---
updated-dependencies:
- dependency-name: SauceControl.InheritDoc
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot requested a review from a team as a code owner April 26, 2024 06:47
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Apr 26, 2024
@dependabot dependabot bot requested a review from a team as a code owner April 26, 2024 06:47
@bbtbir bbtbir merged commit b34a196 into develop Apr 29, 2024
2 checks passed
@bbtbir bbtbir deleted the dependabot/nuget/src/SauceControl.InheritDoc-2.0.1 branch April 29, 2024 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Development

Successfully merging this pull request may close these issues.

1 participant