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

Type synonyms should be listed on left hand side #5784

Open
scabug opened this issue May 10, 2012 · 9 comments
Open

Type synonyms should be listed on left hand side #5784

scabug opened this issue May 10, 2012 · 9 comments

Comments

@scabug
Copy link

@scabug scabug commented May 10, 2012

Type synonyms in package objects are only listed on the right-hand side of the scaladoc, if you first click on the package object on the left-hand side. They are never listed on the left-hand side. This has confused me, a relative Scala newbie, a number of times.

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented May 10, 2012

Imported From: https://issues.scala-lang.org/browse/SI-5784?orig=1
Reporter: Robin Green (greenrd)

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented May 15, 2012

@VladUreche said:
Thanks for reporting it, Robin.

Heather, what do you think of this? Do you see any way of adding aliased types (type synonyms) without cluttering the right sidebar?

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented May 18, 2012

@heathermiller said:
Good observation. Though, I'm not so sure it makes a lot of sense to list type aliases in the left side-bar-- you can't click to navigate to a type alias. If there was a way to link to methods in Scaladoc, this would make a bit more sense. Then, you could at least link to the type member on the package page. But regardless, I think that adding type aliases to the left sidebar would likely add a lot of noise that people might not like in general.

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented May 21, 2012

@VladUreche said:
Thinking more about it, I would rather improve the documentation for the root package than putting type aliases in the list: Program-wide type aliases are defined in the scala package and in scala.Predef, both of which are automatically imported. Since this solution would only work for half the problem (the scala package) I would suggest not putting in into practice, but rather thinking of a better alternative.

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Jul 11, 2012

@VladUreche said:
Bumping to Critical, this will be need to document reflection.

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Jul 20, 2012

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Jul 23, 2012

@VladUreche said:
For alias and abstract types this it is now possible to annotate the doc comment with @documentable (or @template) to get a page for the type and list it on the right:

/** ...
 *  @template
 */
type Set[A]     = immutable.Set[A]

I will leave this bug open so we decide if we really want to have that for java classes, for which we don't have any doc comments. (String is a good example, you'll get a page with all of String's methods, but none of them has comments, as the class is Java-defined and the source code is not recompiled)

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented May 20, 2013

@JamesIry said:
2.10.2 is about to be cut. Kicking down the road and un-assigning to foster work stealing.

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.