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

Rustdoc should render the Fn traits with the sugary syntax #19909

Closed
ftxqxd opened this issue Dec 16, 2014 · 1 comment
Closed

Rustdoc should render the Fn traits with the sugary syntax #19909

ftxqxd opened this issue Dec 16, 2014 · 1 comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@ftxqxd
Copy link
Contributor

ftxqxd commented Dec 16, 2014

Rustdoc currently displays Fn, FnMut, and FnOnce like Fn<(Args,), Return>. That syntax is unsightly and will not be usable post-1.0, so it should probably render them as Fn(Args) -> Return instead.

@sfackler sfackler added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 16, 2014
@tomjakubowski
Copy link
Contributor

this is a dupe of #19877 but since that one never got tagged I'll close it. I've got a patch almost ready for this.

alexcrichton added a commit to alexcrichton/rust that referenced this issue Dec 17, 2014
This is to encourage the use of the sugary syntax instead of the `<>` syntax, which will not be usable post-1.0. Rustdoc [still uses the `<>` syntax](rust-lang#19909), so if a rustdoc wizard is looking for something to do, it would be nice to use the parenthetical syntax there as well. (I tried to patch rustdoc as well, but failed…)
tomjakubowski added a commit to tomjakubowski/rust that referenced this issue Dec 24, 2014
This unfortunately leaves sugaring Fn/FnMut/FnOnce on cross-crate
re-exports for future work.

cc rust-lang#19909
@bors bors closed this as completed in 64b5464 Dec 25, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants