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

Reopening of #13739: rustdoc: Inline reexported items if possible. #14012

Closed

Conversation

lifthrasiir
Copy link
Contributor

Mostly fixes #13045. See #13739 for the screenshots and detailed discussion; the main change remains same. I completely forgot to rebase in spite of #13777 (which also alters the very same files) being merged...

some examples to look at: `std::io`, `std::prelude`, `libc`.

there are some known exceptions to inlining (e.g. statics),
so they are preserved to the reexport section as much as possible.
it would be desirable to remove such exceptions in the future.
@adrientetar
Copy link
Contributor

So I was looking at that screenshot and was wondering how to make it shorter since it is very verbose esp. when it appears repeatedly.
While I was originally thinking of a circled 'R' letter, I think we could rather use an icon set out in grey, like this one? It could be individually embedded in CSS to avoid any additional HTTP request.

Something else: do we want to add some margin before the text so that we can set the marker aside? (So that lines with reexported marker line up with those that don't have it)

@lifthrasiir
Copy link
Contributor Author

@adrientetar A concise icon would be helpful indeed. I'm less sure if the refresh icon is apt for this purpose; maybe reply or retweet can be better (assuming we don't have anything related to the email or Twitter in the docs :).

@alexcrichton
Copy link
Member

Closing due to inactivity, but feel free to reopen with a rebase!

bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 13, 2023
Adding section for Visual Studio IDE Rust development support

This PR adds a section for Rust support in Visual Studio IDE.
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 13, 2023
Expand docs section on Visual Studio to mention all three available extensions

A recent PR (rust-lang#14012) by `@parthopdas` added mention of rust-analyzer.vs, his extension for Visual Studio 2022.  I am submitting this PR to request that our extension (SourceGear Rust) be mentioned in that section as well, and also, for completeness, the VS_RustAnalyzer extension, by `@cchharris.`

Our extension is closed source, so I have clearly disclosed that.  For consistency, I included brief mention of the licenses for the other two options as well.  Also for the sake of consistency, I added marketplace and GitHub links for all 3.

The previously added paragraph by `@parthopdas` about his extension has been left intact.
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.

Rustdoc should allow reexports to manually request their docs to be inlined
3 participants