Skip to content

Remove documentation for std_detect error_macros #1245

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

Conversation

adamgemmell
Copy link
Contributor

@adamgemmell adamgemmell commented Nov 3, 2021

These comments show up when there's proper documentation for the runtime feature detection macros, such as here: https://doc.rust-lang.org/nightly/std/macro.is_aarch64_feature_detected.html

The messages also make no sense from an API user's perspective.

@rust-highfive
Copy link

r? @Amanieu

(rust-highfive has picked a reviewer for you, use r? to override)

@Amanieu
Copy link
Member

Amanieu commented Nov 4, 2021

I think the proper solution here would be to use cfg(doc) to show the proper documentation for all arch-specific macros when rustdoc is used.

@adamgemmell
Copy link
Contributor Author

That does seem useful, thanks, I'll update the PR. To me it still makes sense to remove this error documentation - do you agree?

@Amanieu
Copy link
Member

Amanieu commented Nov 4, 2021

Yes, it's fine to change these to normal comments instead of doc comments.

@bors
Copy link
Contributor

bors commented Dec 8, 2021

☔ The latest upstream changes (presumably f4513d5) made this pull request unmergeable. Please resolve the merge conflicts.

@Amanieu
Copy link
Member

Amanieu commented Jan 28, 2022

Superseded by #1276.

@Amanieu Amanieu closed this Jan 28, 2022
@adamgemmell adamgemmell deleted the dev/error-macros-docs branch January 28, 2022 11:42
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.

4 participants