Skip to content

Update #[doc(html_playground_url)] documentation to mention what the request will be #97972

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

Merged
merged 2 commits into from
Jun 11, 2022
Merged

Update #[doc(html_playground_url)] documentation to mention what the request will be #97972

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2147a06
Update the-doc-attribute.md
ranile Jun 10, 2022
74d210e
Update the-doc-attribute.md
ranile Jun 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,9 @@ on your documentation examples make requests to.
#![doc(html_playground_url = "https://playground.example.com/")]
```

Now, when you press "run", the button will make a request to this domain.
Now, when you press "run", the button will make a request to this domain. The request
URL will contain 2 query parameters: `code` and `edition` for the code in the documentation
and the Rust edition respectively.

If you don't use this attribute, there will be no run buttons.

Expand Down