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

Resolve C-EXAMPLE violations #2623

Open
bugadani opened this issue Nov 28, 2024 · 0 comments
Open

Resolve C-EXAMPLE violations #2623

bugadani opened this issue Nov 28, 2024 · 0 comments
Labels
1.0-blocker documentation Improvements or additions to documentation

Comments

@bugadani
Copy link
Contributor

As documentation isn't as immutable as the API is, we may not treat rustdoc examples as strictly as the Rust API guidelines wants us to do. This issue is meant as a reminder to resolve the guidelines in however we will see fit, before 1.0.

https://rust-lang.github.io/api-guidelines/documentation.html#c-example

@bugadani bugadani added the documentation Improvements or additions to documentation label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0-blocker documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant