Skip to content

rustdoc: warn for notrust tags #19693

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

Closed
wants to merge 1 commit into from
Closed

Conversation

skade
Copy link
Contributor

@skade skade commented Dec 10, 2014

Rustdoc should warn when notrust is used. The tag can be replaced by an actual code marker like c, plain, console etc.

One outstanding issue is that rustdoc has no default log level thus does not print the warning in normal use. Is there a good way to raise that?

Following the discussion here:

rust-lang/rfcs#500

@steveklabnik
Copy link
Member

I'd be for removing it entirely, but this is good too.

@skade
Copy link
Contributor Author

skade commented Dec 10, 2014

I'd be for that as well, if an immediate breaking change is okay. Otherwise, I'd do it in the future.

@alexcrichton
Copy link
Member

For now this seems like a weird way to warn as all the warn! macro does is print to stderr. Unlike our other compiler diagnostics it doesn't connect to any form of source location so it's difficult to know where the blocks are. Additionally it would be nice to handle all the uses of notrust in the compiler itself instead of letting all the warnings print on the build.

@alexcrichton
Copy link
Member

@skade would you be ok with outright removing this for now? This is somewhat of a niche feature so it's ok to break it for now.

@steveklabnik
Copy link
Member

👍

@skade
Copy link
Contributor Author

skade commented Dec 19, 2014

I'd be okay with removing that. If breakage is okay for you, I'd create and test the patch tonight.

@alexcrichton
Copy link
Member

Sure, thanks!

@skade
Copy link
Contributor Author

skade commented Dec 20, 2014

Closed in favor of #20075.

@skade skade closed this Dec 20, 2014
alexcrichton added a commit to alexcrichton/rust that referenced this pull request Dec 22, 2014
Internally refactor all mentions of `notrust` to the
positive statement `rust`.

[breaking-change] Change remaining `notrust` markers to
the thing they actually represent, e.g. `sh` or `plain`.

This supersedes rust-lang#19693 .
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.

3 participants