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

Slim doc generation #2671

Merged
merged 4 commits into from
Sep 29, 2023
Merged

Slim doc generation #2671

merged 4 commits into from
Sep 29, 2023

Conversation

kennykerr
Copy link
Collaborator

@kennykerr kennykerr commented Sep 28, 2023

While looking into #2665, I found some areas where the doc generation could be simplified. Mainly this removes a bunch of redundant doc comments. And shaves a few hundred thousand lines of code. 😏

@kennykerr kennykerr merged commit 5b092bc into master Sep 29, 2023
47 checks passed
@kennykerr kennykerr deleted the slimdocs branch September 29, 2023 13:09
@tim-weis
Copy link
Contributor

The "Required features" documentation items seem to have dropped the quotation marks around the features. That's unfortunate as it requires extra work to copy them into a Cargo.toml file now. It would be nice to have them back unless there is a compelling reason for this change.

@kennykerr
Copy link
Collaborator Author

Right, I originally removed them as the italics rendering was causing some problems where the quotes were not plain quotes supported by toml but it seems now that it's not italic that it would work fine so I can add them back.

@tim-weis
Copy link
Contributor

tim-weis commented Oct 2, 2023

Thanks!

For reference, the non-ASCII quotation marks transformation was fixed[citation needed] by wrapping the quoted feature names in backticks (`). This has worked reliably with and without italics. I liked the italics better, but I can probably be trained to like the new layout no less than the old, familiar formatting, given enough training data.

@kennykerr
Copy link
Collaborator Author

Great, the whole docs things has been frustrating and tedious as rustdoc is so problematic that I've forgotten some of the twists and turns. I'm still considering scrapping it in favor of generating docs directly.

bors referenced this pull request in rust-lang/cargo Dec 1, 2023
chore(deps): update rust crate windows-sys to 0.52

[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [windows-sys](https://togithub.com/microsoft/windows-rs) | workspace.dependencies | minor | `0.48` -> `0.52` |

---

### Release Notes

<details>
<summary>microsoft/windows-rs (windows-sys)</summary>

### [`v0.52.0`](https://togithub.com/microsoft/windows-rs/releases/tag/0.52.0)

[Compare Source](https://togithub.com/microsoft/windows-rs/compare/0.48.0...0.52.0)

This release includes updates to all crates. This includes the first update to the `windows-sys` crate in 8 months. It also includes the first published version of the [riddle](https://crates.io/crates/riddle) tool and the [windows-version](https://crates.io/crates/windows-version) crate.

#### What's Changed

-   Simplify issue templates by [`@&#8203;riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2621](https://togithub.com/microsoft/windows-rs/pull/2621)
-   Switch all crates to Rust edition 2021 by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2620](https://togithub.com/microsoft/windows-rs/pull/2620)
-   Correct workflow trigger ignore paths by [`@&#8203;riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2622](https://togithub.com/microsoft/windows-rs/pull/2622)
-   Detect unused `bindgen`/`riddle` filters by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2634](https://togithub.com/microsoft/windows-rs/pull/2634)
-   Fix `BOOLEAN` parameter binding by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2635](https://togithub.com/microsoft/windows-rs/pull/2635)
-   Provide individual crate readme files by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2645](https://togithub.com/microsoft/windows-rs/pull/2645)
-   Tweak Win32 error code conversion to handle `HRESULT` input by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2646](https://togithub.com/microsoft/windows-rs/pull/2646)
-   Remove support for the defunct `StaticLibrary` attribute by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2647](https://togithub.com/microsoft/windows-rs/pull/2647)
-   Derive `PartialEq`, `Eq`, `Debug`, `Clone` for interfaces by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2651](https://togithub.com/microsoft/windows-rs/pull/2651)
-   Internal `bindgen` refactoring by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2654](https://togithub.com/microsoft/windows-rs/pull/2654)
-   Disable signature transformation for `NTSTATUS` by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2658](https://togithub.com/microsoft/windows-rs/pull/2658)
-   Unhide `query` method on `ComInterface` trait by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2659](https://togithub.com/microsoft/windows-rs/pull/2659)
-   Harden `QueryInterface` implementation by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2660](https://togithub.com/microsoft/windows-rs/pull/2660)
-   Mask non-reproducible linker artifacts in libs by [`@&#8203;riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2661](https://togithub.com/microsoft/windows-rs/pull/2661)
-   Slim doc generation by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2671](https://togithub.com/microsoft/windows-rs/pull/2671)
-   Update SDK and WDK metadata by [`@&#8203;riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2664](https://togithub.com/microsoft/windows-rs/pull/2664)
-   Add feature documentation quotes by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2675](https://togithub.com/microsoft/windows-rs/pull/2675)
-   Add `docs` feature by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2676](https://togithub.com/microsoft/windows-rs/pull/2676)
-   Simplify metadata reader by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2682](https://togithub.com/microsoft/windows-rs/pull/2682)
-   Add bindgen config option to disable generating inner attributes by [`@&#8203;dpaoliello](https://togithub.com/dpaoliello)` in [https://github.com/microsoft/windows-rs/pull/2683](https://togithub.com/microsoft/windows-rs/pull/2683)
-   Simplify metadata filtering by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2684](https://togithub.com/microsoft/windows-rs/pull/2684)
-   Simplify code generation by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2686](https://togithub.com/microsoft/windows-rs/pull/2686)
-   Fix link from docs.rs to full API documentation by [`@&#8203;ChrisDenton](https://togithub.com/ChrisDenton)` in [https://github.com/microsoft/windows-rs/pull/2688](https://togithub.com/microsoft/windows-rs/pull/2688)
-   Optimize tick trimming by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2689](https://togithub.com/microsoft/windows-rs/pull/2689)
-   Small bindgen refactor and tools refresh by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2695](https://togithub.com/microsoft/windows-rs/pull/2695)
-   Document `implement` and `interface` macros by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2696](https://togithub.com/microsoft/windows-rs/pull/2696)
-   Perform checked integral type conversions for APIs by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2699](https://togithub.com/microsoft/windows-rs/pull/2699)
-   Add `windows-version` crate by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2702](https://togithub.com/microsoft/windows-rs/pull/2702)
-   Add crate-specific readme files by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2703](https://togithub.com/microsoft/windows-rs/pull/2703)

#### New Contributors

-   [`@&#8203;dpaoliello](https://togithub.com/dpaoliello)` made their first contribution in [https://github.com/microsoft/windows-rs/pull/2683](https://togithub.com/microsoft/windows-rs/pull/2683)

**Full Changelog**: microsoft/windows-rs@0.48.5...0.52.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 5am on the first day of the month" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/rust-lang/cargo).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy41OS44IiwidXBkYXRlZEluVmVyIjoiMzcuNTkuOCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->
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.

2 participants