Skip to content

[dotnet] Fix missing documentation comments in NuGet package #10376

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

Merged
merged 2 commits into from
Apr 21, 2022

Conversation

BaerMitUmlaut
Copy link
Contributor

Description

All .nuspec files failed to include the XML files containing documentation comments. This regression was introduced with d77555a and affects v4.0.0, v4.0.1 and v4.1.0.

Fixes:

Both have been closed as duplicates of an unrelated bug (missing online documentation). Please consider reopening #10371 to track the underlying issue until this has been fixed. Both bugs do not mention online documentation, so I don't understand why they were closed.

Motivation and Context

Starting with version 4.0.0, all documentation comments were missing. This is because the XML file that contains those comments has been inadvertently excluded from the NuGet package.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

I was unable to test my changes because I was unable to complete a full build. Please consider improving your build instructions if you require such a complex build with this amount of dependencies.

@CLAassistant
Copy link

CLAassistant commented Feb 18, 2022

CLA assistant check
All committers have signed the CLA.

@titusfortner titusfortner added the C-dotnet .NET Bindings label Apr 13, 2022
@nvborisenko
Copy link
Member

Nobody? Easy fix.

Copy link
Member

@diemol diemol left a comment

Choose a reason for hiding this comment

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

Thank you, @BaerMitUmlaut!

@diemol diemol merged commit da9f04f into SeleniumHQ:trunk Apr 21, 2022
@nvborisenko
Copy link
Member

4.2.0 was released without xml files in the nuget package. Thus inline documentation still doesn't work.

I think I am able to propose a fix for this, but building solution locally is a big pain.

@BaerMitUmlaut
Copy link
Contributor Author

That's a shame. I wasn't able to make a proper build, maybe you'll have better luck.

@titusfortner
Copy link
Member

reopened the issue. I'm guessing it needs to be added to bazel somewhere in order to be included

elgatov pushed a commit to elgatov/selenium that referenced this pull request Jun 27, 2022
Co-authored-by: Diego Molina <diemol@users.noreply.github.com>
@Tony-Liou
Copy link

Maybe adding <GenerateDocumentationFile>true</GenerateDocumentationFile> to csproj file would fix it.
Since #10371 has been locked, I am leaving comments here.

@nvborisenko
Copy link
Member

Everything, you know how to do it, does not work because of bazel.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-dotnet .NET Bindings
6 participants
close