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

Refer to create_instance in CoCreateInstance documentation #980

Closed
saschanaz opened this issue Jul 14, 2021 · 3 comments · Fixed by #998
Closed

Refer to create_instance in CoCreateInstance documentation #980

saschanaz opened this issue Jul 14, 2021 · 3 comments · Fixed by #998
Labels
enhancement New feature or request

Comments

@saschanaz
Copy link

Doing so will help users learn the easier helper function exists. 👍

@saschanaz saschanaz changed the title Refer to create_instance for CoCreateInstance documentation Refer to create_instance in CoCreateInstance documentation Jul 14, 2021
@kennykerr
Copy link
Collaborator

I assume you mean this documentation?

https://github.com/microsoft/windows-docs-rs (repo)
https://microsoft.github.io/windows-docs-rs (docs)

This is simply generated from metadata and there is no way currently to add hand-written documentation although there are a few issues for improving docs including #931 #851 #546

At this point that documentation is just an experiment and I'm not yet sure where to go with it. Cargo docs doesn't really scale to the sheer size of the Windows API so I'm not sure whether it is a useful approach long term.

Happy to hear your thoughts.

@kennykerr kennykerr added the enhancement New feature or request label Jul 14, 2021
@saschanaz
Copy link
Author

Yes, the docs-rs page is my reference for everything so I would be happy if there is a way to notify the existence of helpers for certain raw functions.

@kennykerr
Copy link
Collaborator

Actually, with the work I've recently done to simplify many COM functions and method callsites, I think I'll probably remove the helpers I originally added to the Windows crate entirely since they add little value and aren't particularly discoverable or maintainable. I'd rather the Windows crate focus on providing the highest quality API bindings and let other crates come along and support specific APIs in more idiomatic ways (once #432 lands).

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

Successfully merging a pull request may close this issue.

2 participants