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

create a proper rust documentation with all the generated methods #2

Open
jdrouet opened this issue Nov 10, 2021 · 1 comment
Open
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@jdrouet
Copy link

jdrouet commented Nov 10, 2021

Great work on the powercap module but as a Rust developer, having to go dig in a header file in a different repo isn't really user friendly. Would that be possible to create a rust documentation?

Thanks 😉

@connorimes
Copy link
Member

Hi @jdrouet , thanks for the feedback. I think the upstream powercap C package (https://github.com/powercap/powercap) needs to generate and publish that documentation, since that's where the headers and source live. Then this crate can just link back to that and perhaps provide some simple Rust examples.

I'm not sure when I can get to this myself. If you're interested in contributing, I'd be happy to discuss approaches (like which tools to use) and review PRs though. Cheers.

@connorimes connorimes added enhancement New feature or request help wanted Extra attention is needed labels Nov 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants