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

Rename struct NVML to Nvml #22

Merged
merged 6 commits into from
Dec 12, 2021
Merged

Rename struct NVML to Nvml #22

merged 6 commits into from
Dec 12, 2021

Conversation

TheJltres
Copy link
Contributor

@TheJltres TheJltres commented Dec 12, 2021

This PR should solve #16

I'm starting with Rust, and for a project I need NVML library, and searching for C/C++ native builds, I found this repo, and while I was reading the docs, I thought of helping a little 😄

I think I covered all documentation

@Cldfire
Copy link
Owner

Cldfire commented Dec 12, 2021

Thanks for thinking of helping and putting this PR together! It's looking great so far and I really appreciate it :).

CI is failing for reasons unrelated to this PR; I'm going to go fix that up and open a separate PR to resolve that.

In the meantime, one thing we should add to this PR is a changelog entry. I'm thinking something like the following would work well:

 # nvml-wrapper Changelog
 
 This file describes the changes / additions / fixes between wrapper releases, tracked in a loose version of the [keep a changelog](https://keepachangelog.com/en/1.0.0/) format.
 
 ## [Unreleased]
 
+ ### Changed
+ 
+ * The `NVML` struct has been renamed to `Nvml` (#22 - @TheJltres)
+
 ### Dependencies
 
 * `libloading`: `0.6.6` -> `0.7.0`
 
 ### Internal
 
 * Re-organized repo using a workspace
 * Tests that can't be run on my machine are now ignored with the `#[ignore]` attribute. The `test-local` feature has been removed as a result
 
 ## [0.7.0] (released 2020-12-06)

@Cldfire
Copy link
Owner

Cldfire commented Dec 12, 2021

Ok, if you merge master into this PR CI will be happy now :)

@TheJltres
Copy link
Contributor Author

Sorry, totally forgot about the Changelog

The merge is done 🚀

@Cldfire Cldfire linked an issue Dec 12, 2021 that may be closed by this pull request
@Cldfire Cldfire merged commit d682fb6 into Cldfire:master Dec 12, 2021
@Cldfire
Copy link
Owner

Cldfire commented Dec 12, 2021

Sweet, thank you! And no worries on the changelog, I forget it sometimes too.

I may not release a version with this change in it for a little while (since it's a breaking change), but it will go out to everyone whenever the next release happens 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename NVML struct to Nvml
2 participants