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 search unbearable on small screens #23340

Closed
mahkoh opened this issue Mar 13, 2015 · 11 comments
Closed

rustdoc search unbearable on small screens #23340

mahkoh opened this issue Mar 13, 2015 · 11 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@mahkoh
Copy link
Contributor

mahkoh commented Mar 13, 2015

search

@steveklabnik
Copy link
Member

What is 'unbearable'?

@mahkoh
Copy link
Contributor Author

mahkoh commented Mar 13, 2015

rustdoc search

If you can look at that screenshot without noticing a problem then trying to explain it is a waste of time.

@aturon aturon added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Mar 13, 2015
@wycats
Copy link
Contributor

wycats commented Mar 13, 2015

@steveklabnik Don't you agree that the existing docs for finally would make it very hard for even an intermediate-level Rust programmer to figure out what's going on?

@wycats
Copy link
Contributor

wycats commented Mar 13, 2015

I can see at least three different issues here.

  1. There are a lot of finallys, and it's not clear here which you should be looking at
  2. The descriptions are truncated badly, so it's hard to even get a sense of where you should start looking
  3. The list doesn't include information about whether each entry is a trait, struct, typedef, method, or whatever.

@steveklabnik
Copy link
Member

I noticed #2, but didn't realize #1 or #3. This is why reports more than just "unbearable" is important, and why it's not a "waste of time" to spell out what you mean.

@mahkoh
Copy link
Contributor Author

mahkoh commented Mar 13, 2015

You saw that the documentation provided for "Finally" is "A trait for executing a..." but you didn't consider that unbearable. For your own sake I'll assume that you're kidding.

@huonw
Copy link
Member

huonw commented Mar 13, 2015

@mahkoh it would take you 20 seconds to write a sentence or two to make issues clearer as you file them. You have been repeatedly requested to do things like this. Something that is obvious to you is not obvious to everyone.

While I agree that this specific issue is reasonably clear, it would still be improved by some text and/or a link to an example search page. Doing this helps everyone else help you.

@mahkoh
Copy link
Contributor Author

mahkoh commented Mar 13, 2015

While I agree that this specific issue is reasonably clear

It's so clear that @wycats, @steveklabnik, I, and apparently you were able to notice the problem independently without any additional explanation.

and/or a link to an example search page

I don't see how that's better than a screenshot.

@tomjakubowski
Copy link
Contributor

It's so clear that @wycats, @steveklabnik, I, and apparently you were able to notice the problem independently without any additional explanation.

I noticed a few things that some might argue are problems and a couple things I thought were definitely problems. I had absolutely no idea which of those specifically you were reporting here because you just posted a screenshot with minimal context and expected it to be perfectly clear. People on the Internet can be many things but I've never met one who's a mind reader.

@mahkoh
Copy link
Contributor Author

mahkoh commented Mar 14, 2015

Apparently people are more interested in discussing the way the issue was posted than the issue itself. In that case it is just wasting the time of everyone involved (including myself) and I don't want that. Instead I'll try to submit a PR in the following days that fixes the issue.

@mahkoh mahkoh closed this as completed Mar 14, 2015
@huonw
Copy link
Member

huonw commented Mar 14, 2015

A link makes it super easy for someone inclined to fix the issue to dive in with their browser's dev tools.

In any case, your behaviour is horrid. A clarification question was asked (i.e. there was some confusion/inclarity) and your responses were glib, disrespectful and antagonistic. Maybe you think the question is silly, but there's absolutely no reason to be so meanspirited. It would've been trivial to spend the time it took to be unpleasant to give a few dot points like @wycats did.

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

6 participants