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

Support better embedded code in rustdoc #11974

Closed
adsnaider opened this issue Oct 30, 2024 · 1 comment
Closed

Support better embedded code in rustdoc #11974

adsnaider opened this issue Oct 30, 2024 · 1 comment
Labels
C-enhancement Category: Improvements

Comments

@adsnaider
Copy link

Apologies if this has been opened before, I haven't been able to find this.

Request

There's little editor support when writing rustdoc comments that specifically embed Rust doctests.

Wanted Features

  1. Continue the /// block on new line insert (this is just generally useful for normal comments as well)
  2. Ideally figure out the right indentation level based on the code block written
  3. Add syntax highlighting
@adsnaider adsnaider added the C-enhancement Category: Improvements label Oct 30, 2024
@the-mikedavis
Copy link
Member

Point 1 was merged the other day in #10996 - <ret> in insert mode or o/O in normal mode continue line comments, choosing regular comments or doc comments based on the line being extended. #11742 was also merged after the latest release and is a nice QoL improvement for (doc) comments.

2 is covered by the indents bullet in #9425. That would need to build off a change to highlight doc comments as markdown: #3391. I'll close this in favor of the existing issues

@the-mikedavis the-mikedavis closed this as not planned Won't fix, can't repro, duplicate, stale Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: Improvements
Projects
None yet
Development

No branches or pull requests

2 participants