Skip to content

rustdoc: unstable should show feature name and issue #27860

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

Merged
merged 9 commits into from
Aug 22, 2015

Conversation

m4rw3r
Copy link
Contributor

@m4rw3r m4rw3r commented Aug 16, 2015

Implemented #27759

Example:

screen shot 2015-08-16 at 21 45 17

@rust-highfive
Copy link
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@killercup
Copy link
Member

Very cool!

If the screenshot is accurate, I'd suggest making the font size of the name of the feature a bit smaller and changing it's background to transparent.

@m4rw3r
Copy link
Contributor Author

m4rw3r commented Aug 17, 2015

I pretty much just imitated the style used by github in that example in the linked issue since it seemed like it made the feature name clear, but here is an alternative without the background and with a slightly smaller font-size:
screen shot 2015-08-17 at 14 33 22

Is this better?

@killercup
Copy link
Member

@m4rw3r I like this second version better. I'm no authority on the visual design of rustdoc, though :)

@alexcrichton
Copy link
Member

Awesome, thanks @m4rw3r! A few thoughts:

  • Could this avoid adding a CLI option to rustdoc for now? The flag interface is already a bit too ambitious I think and it'd be nice to keep it under control!
  • The new issue_tracker_base_url probably only needs to be added to the standard library and facade crates, it should be ok to omit for all the rustc_private and above crates
  • Could you host these docs so we could poke around a bit?
  • Could you add a test for this as well? (see src/test/rustdoc)

@m4rw3r
Copy link
Contributor Author

m4rw3r commented Aug 17, 2015

@alexcrichton I put a copy of the docs rendered with my branch on github pages: http://m4rw3r.github.io/rust/std/result/enum.Result.html#method.expect

@alexcrichton
Copy link
Member

Thanks @m4rw3r!

@steveklabnik
Copy link
Member

looks really nice

@tshepang
Copy link
Member

so kool

@alexcrichton
Copy link
Member

@bors: r+ 6532a08

Thanks @m4rw3r! Also feel free to ping a PR whenever you force push it, unfortunately github doesn't send out notifications on those events :(

@m4rw3r
Copy link
Contributor Author

m4rw3r commented Aug 20, 2015

@alexcrichton iirc I did not force-push this one, but I will keep that in mind if I do force push something. Github had some problems with git-pull about 2 days ago, that caused the travis build to be delayed.

Now on to find some other thing to implement for rustdoc :)

@bors
Copy link
Collaborator

bors commented Aug 22, 2015

⌛ Testing commit 6532a08 with merge e9b74a9...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants