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

Add ProcessLogger use case example to scaladoc #5243

Closed
scabug opened this issue Nov 29, 2011 · 6 comments
Closed

Add ProcessLogger use case example to scaladoc #5243

scabug opened this issue Nov 29, 2011 · 6 comments

Comments

@scabug
Copy link

scabug commented Nov 29, 2011

It is too hard to understand how to use ProcessLogger without a clear example use case.

@scabug
Copy link
Author

scabug commented Nov 29, 2011

Imported From: https://issues.scala-lang.org/browse/SI-5243?orig=1
Reporter: Eric Kolotyluk (kolotyluk)
Affected Versions: 2.9.2, 2.10.0

@scabug
Copy link
Author

scabug commented Jul 10, 2013

@adriaanm said:
Unassigning and rescheduling to M6 as previous deadline was missed.

@scabug
Copy link
Author

scabug commented Nov 12, 2015

Harit Himanshu (hhimanshu) said:
The documentation is http://www.scala-lang.org/api/current/index.html#scala.sys.process.ProcessLogger has an example, are we saying we need to make it more explicit?

@ilango123
Copy link

ilango123 commented Jun 20, 2017

@scabug could you throw a little more light on why this bug is open? I beg your pardon, I am trying to be a contributor and chose this to be a place to start.
For example, in https://www.scala-lang.org/api/current/scala/Option.html, there are code examples that demonstrate a use-case for Option.
Are we looking for something similar for ProcessLogger? I noticed there is an example, in the source code for ProcessLogger from 2.11.8. For instance, if that example were to be shown on the ProcessLogger documentation page, would that be enough to close this bug?
Please advise.

@SethTisue
Copy link
Member

could you throw a little more light on why this bug is open?

(possibly no reason — one form of participation that's really helpful in this repo is simply to identify tickets that shouldn't remain open)

For example, in https://www.scala-lang.org/api/current/scala/Option.html, there are code examples that demonstrate a use-case for Option.
Are we looking for something similar for ProcessLogger? I noticed there is an example, in the source code for ProcessLogger from 2.11.8.
For instance, if that example were to be shown on the ProcessLogger documentation page, would that be enough to close this bug?
Please advise.

That example is in a Scaladoc comment, so it appears in the API doc as well. If you're not seeing it, it could be because you're looking at the doc for the ProcessLogger companion object instead of for the trait. The big "T" and "O" flip back and forth. http://www.scala-lang.org/api/2.12.2/scala/sys/process/ProcessLogger.html

It appears to me that this ticket predates scala/scala@838c97b, the commit that added the example in question, and this should have been closed when that was merged. Closing.

@SethTisue SethTisue removed this from the Backlog milestone Jun 20, 2017
@ilango123
Copy link

You are right. I was looking at the doc for the Companion object instead of for the trait. Glad it is closed now.

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

4 participants