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.

Sign up for GitHub

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

Jump to bottom

fix: package XML documentation #633

Merged
merged 6 commits into from
May 17, 2024
Merged

fix: package XML documentation #633

merged 6 commits into from
May 17, 2024

Conversation

alespour
Copy link
Contributor

@alespour alespour commented May 17, 2024 •
edited
Loading

Closes #574

Proposed Changes

Changes project files for Client, Client.Core, Client.Linq and Client.Legacy to generate XML documentation and include it in nuget packages.

Installed packages before:

./packages/influxdb.client/4.15.0/lib/netstandard2.1/InfluxDB.Client.dll
./packages/influxdb.client/4.15.0/lib/netstandard2.0/InfluxDB.Client.dll
...

After changes:

./packages/influxdb.client/4.15.0-dev/lib/netstandard2.1/InfluxDB.Client.xml
./packages/influxdb.client/4.15.0-dev/lib/netstandard2.1/InfluxDB.Client.dll
./packages/influxdb.client/4.15.0-dev/lib/netstandard2.0/InfluxDB.Client.xml
./packages/influxdb.client/4.15.0-dev/lib/netstandard2.0/InfluxDB.Client.dll
...

image

Checklist

  • CHANGELOG.md updated
  • Rebased/mergeable
  • A test has been added if appropriate
  • dotnet test completes successfully
  • Commit messages are conventional

@alespour alespour force-pushed the chore/nuget-doc branch 2 times, most recently from a1e0cc5 to d1f746c Compare May 17, 2024 10:55
@alespour alespour marked this pull request as ready for review May 17, 2024 11:09
@alespour alespour requested review from bednar and removed request for bednar May 17, 2024 11:10
@alespour alespour marked this pull request as draft May 17, 2024 11:27
bednar
bednar requested changes May 17, 2024
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
@alespour alespour marked this pull request as ready for review May 17, 2024 11:51
bednar
bednar approved these changes May 17, 2024
View reviewed changes
Copy link
Contributor

@bednar bednar left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@alespour alespour merged commit cdd8cae into master May 17, 2024
9 checks passed
@alespour alespour deleted the chore/nuget-doc branch May 17, 2024 11:52
@bednar bednar added this to the 4.16.0 milestone May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bednar bednar bednar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
4.16.0
Development

Successfully merging this pull request may close these issues.

Q: Why are documentation files not generated?
2 participants
@alespour @bednar