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.

Sign up for GitHub

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

Jump to bottom

Document which Buf and BufMut functions require std #591

Merged
merged 4 commits into from Jan 31, 2023
Merged

Document which Buf and BufMut functions require std #591

merged 4 commits into from Jan 31, 2023

Conversation

MrGunflame
Copy link
Contributor

Marks Buf and BufMut functions that depend on std as so.

@MrGunflame
Copy link
Contributor Author

This would require a nightly rustdoc. Would it make sense to switch CI to a nightly rustdoc job (like tokio does)?

@Darksonn
Copy link
Contributor

Nightly rustdoc is fine. You should add the full command with --cfg docsrs in the readme too.

@MrGunflame
Copy link
Contributor Author

Switched the publish_docs to nightly and added a section in the readme.

Darksonn
Darksonn approved these changes Jan 31, 2023
View reviewed changes
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@Darksonn Darksonn merged commit f15bba3 into tokio-rs:master Jan 31, 2023
@Darksonn Darksonn mentioned this pull request Jan 31, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Darksonn Darksonn Darksonn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@MrGunflame @Darksonn