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

Enable workspace lint missing_docs #2799

Merged
merged 4 commits into from Jan 17, 2024
Merged

Enable workspace lint missing_docs #2799

merged 4 commits into from Jan 17, 2024

Conversation

kennykerr
Copy link
Collaborator

Ensures that the windows-core crate docs are generated correctly.

  • The CanInto trait is internal and should not be documented.
  • The new VARIANT and PROPVARIANT types are public and needed a basic description.

@kennykerr
Copy link
Collaborator Author

Turns out there's a missing_docs lint that can catch these automatically!

@kennykerr kennykerr changed the title Update windows-core docs Enable workspace lint missing_docs Jan 17, 2024
@kennykerr
Copy link
Collaborator Author

kennykerr commented Jan 17, 2024

Getting a little frustrating that I keep getting some warnings only show up on ubuntu builds and not reproducible on Windows. Anyone else seeing this? @riverar @ChrisDenton

https://github.com/microsoft/windows-rs/actions/runs/7558373269/job/20579758632?pr=2799

@kennykerr
Copy link
Collaborator Author

kennykerr commented Jan 17, 2024

It might be "user error" in this case - I keep forgetting about the silly docs feature... #2676

@kennykerr kennykerr merged commit 587520b into master Jan 17, 2024
65 checks passed
@kennykerr kennykerr deleted the core-docs branch January 17, 2024 17:34
@ChrisDenton
Copy link
Collaborator

It might be "user error" in this case - I keep forgetting about the silly docs feature... #2676

Ah. Hopefully we can remove that sometime this year. The Cargo feature to replace it should be in edition 2024.

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.

None yet

2 participants