Skip to content

Add libcore documentation for macros::builtin (include_bytes!, include_str!, etc.) #36272

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
Closed
newpavlov opened this issue Sep 5, 2016 · 2 comments
Closed

Add libcore documentation for macros::builtin (include_bytes!, include_str!, etc.) #36272

newpavlov opened this issue Sep 5, 2016 · 2 comments

Comments

@newpavlov
Copy link
Contributor

newpavlov commented Sep 5, 2016 •
edited
Loading

While include_bytes!, include_str! and other macros from std::macros::builtin are available with no_std there is no documentation for them in libcore docs.
@TimNN
Copy link
Contributor

TimNN commented Sep 5, 2016

Are you sure they are not available with no_std? As far as I know these are built into the compiler and available in all crates. I think it is only their documentation which is only available in std and not in core.

This should be true for all macros in the std::macros::builtin module.

@newpavlov
Copy link
Contributor Author

Hm, they are indeed available. I will edit this issue.

@newpavlov newpavlov changed the title Add include_bytes!, include_str! and other std macros to libcore. Add libcore documentation for macros::builtin (include_bytes!, include_str!, etc.) Sep 5, 2016
@newpavlov newpavlov mentioned this issue Oct 21, 2016
Merged
bors added a commit that referenced this issue Oct 23, 2016
@bors
Auto merge of #37325 - newpavlov:master, r=frewsxcv
87af232 
libcore documentation for builtin macros

Fixes: #36272

Additionally I've edited docstring for `include!` a bit. (related PR #36404)

Unfortunately it seems there is no sane way to reexport empty macros definitions for their docstrings. To avoid copying the whole documentation for builtin macros I've only copied description and added links to `std` macro pages.
@frewsxcv frewsxcv mentioned this issue Nov 19, 2016
Closed
@bobbinth bobbinth mentioned this issue Dec 10, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@newpavlov @TimNN @apasel422