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

Remove verbose clutter from default argument implicit expansions in scaladoc output #3721

Closed
scabug opened this issue Aug 3, 2010 · 4 comments

Comments

@scabug
Copy link

scabug commented Aug 3, 2010

hi,

i am having a lot of implicit conversions for default arguments using my DSL. for instance:

object BufRd {
   def ar( numChannels: Int, bufID: GE, phase: GE = 0, loop: GE = 1, interp: GE = 2 ) : GE = ...
}

where integers and floats are converted to a GE using an implicit conversion in the scope. now, the result is that scaladoc generates this:

def ar(numChannels: Int, bufID: GE, phase: GE = de.sciss.synth.package.floatToGE(0), loop: GE = de.sciss.synth.package.floatToGE(1), interp: GE = de.sciss.synth.package.floatToGE(2)): GE

which obviously is very ugly and barely readable.

i thus propose an enhancement, for example in the form of a scaladoc switch, to not resolve implicit conversions in the doc-generation but to keep the original readable form of the signatures.

@scabug
Copy link
Author

scabug commented Aug 3, 2010

Imported From: https://issues.scala-lang.org/browse/SI-3721?orig=1
Reporter: @Sciss

@scabug
Copy link
Author

scabug commented Mar 12, 2012

@VladUreche said:
Would it be okay if we just normalize the package name out? meaning it would appear as: floatToGE(0)?

@scabug
Copy link
Author

scabug commented Mar 12, 2012

@Sciss said (edited on Mar 12, 2012 11:41:30 AM UTC):
Hi Vlad, I think this issue has been resolved in Scala 2.9.0 or 2.9.1. Currently I get this printed in the docs:

    def ar (numChannels: Int, buf: GE, index: GE = 0.0f, loop: GE = 1.0f, interp: GE = 2.0f): BufRd

which looks fine and readable to me! Can close this issue?

(BTW can someone check the JIRA markup docs -- the curly quotes for monospaced just don't work)

@scabug scabug closed this as completed Mar 13, 2012
@scabug
Copy link
Author

scabug commented Mar 13, 2012

@VladUreche said:
Great, I closed it.

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

No branches or pull requests

2 participants