scala / bug

Scala 2 bug reports only. Please, no questions — proper bug reports only.
https://scala-lang.org
232 stars 21 forks source link

package focus ineffective #9598

Closed scabug closed 10 months ago

scabug commented 8 years ago

The focus text does little of value when clicked.

This shows the outcome after clicking it,

scabug commented 8 years ago

Imported From: https://issues.scala-lang.org/browse/SI-9598?orig=1 Reporter: @janekdb Affected Versions: 2.11.7 Attachments:

scabug commented 8 years ago

@janekdb said: Browser: Chrome on Windows 10

|Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.80 Safari/537.36|

scabug commented 8 years ago

@felixmulder said (edited on Dec 19, 2015 1:08:03 PM UTC): I think this issue is resolved by PR 4877 on github.

I couldn't reproduce your bug on: https://dl.dropboxusercontent.com/u/358427/scaladoc/index.html

Could you check if it is still present?

scabug commented 8 years ago

@janekdb said: This particular defect is gone but I would regard the current behaviour on https://dl.dropboxusercontent.com/u/358427/scaladoc/index.html as incorrect.

Focucsing on scala.annotation.meta works. Only scala.annotation.meta is shown.

Focucsing on scala.annotation kind of works. We now see scala.annotation, scala.annotation.meta & scala.annotation.unchecked. Including the child packages is is not so useful.

Focucsing on scala does not work. It does not restrict the packages because scala is at the top level. This should be regarded as a defect.

Hide has more useful behaviour. Hiding scala hides only the direct members of the scala package.

On the basis of the rather general title this issue has I would say we are not done yet.

scabug commented 8 years ago

@felixmulder said: I always thought the use case was this:

Bob: "Hmm, I need to find that mappy thingy, I know it's in scala somewhere" [clicks focus on "scala"] Bob: "It should be part of the collections" [clicks focus on collections] Bob: "Alright, I'd like it to be immutable" [clicks "immutable"] Bob: "Ah there it is"

So that's why I figured it was implemented like it currently is. Which also legitimises the way focusing on the scala package works. The discrepancy between hide and focus, however, is perhaps somewhat strange.

One idea would be to ask ourselves what we really want focus to do. Should it eliminate the other packages or should it allow us to navigate the library like traversing directories? If the latter, should we call it something else?

Other things we could ask ourselves is, how often is it used - is it better removed? Do people use the search function instead?

You can achieve the same thing by typing scala.annotation.meta in the filter-field.

SethTisue commented 10 months ago

I don't think the "package focus" thing still exists in current Scaladoc? Let me know if I'm wrong.

The big redesign landed in 2.12.x sometime, so I'll tentatively mark as fixed in 2.12.0.