deprecate StringLike.linesIterator, we have StringLike.lines for that

[scabug]

StringLike.scala has:

  /** Return all lines in this string in an iterator, excluding trailing line
   *  end characters, i.e. apply `.stripLineEnd` to all lines
   *  returned by `linesWithSeparators`.
   */
  def lines: Iterator[String] = 
    linesWithSeparators map (line => new WrappedString(line).stripLineEnd)

  /** Return all lines in this string in an iterator, excluding trailing line
   *  end characters, i.e. apply `.stripLineEnd` to all lines
   *  returned by `linesWithSeparators`.
   */
  def linesIterator: Iterator[String] = 
    linesWithSeparators map (line => new WrappedString(line).stripLineEnd)

The methods are identical. Surely linesIterator should be deprecated and tell people to use lines instead?

[scabug]

Imported From: https://issues.scala-lang.org/browse/SI-4997?orig=1
Reporter: @SethTisue
See #5994

[scabug]

@paulp said:
Since lines is unfortunately ambiguous with the same method in scala.sys.process, it's tempting to go the other way.

[scabug]

@adriaanm said:
since we can only deprecate on .0 releases, it's now or 2.11.0

[scabug]

@Ichoran said:
Simon, have you got this one or shall I steal it?

[scabug]

@soc said:
You can steal it, I haven't had the time to think about it. Paul's comment is certainly valid. Not sure what's the best way here.
If keeping linesIterator would not create any inconsistencies, (e. g. other methods in StringLike return Iterator, without having a method name suffix of "iterator"), I'd slightly favor that approach.

[scabug]

@SethTisue said:
seems to me that sys.process should bow to core string stuff, rather than vice versa

[scabug]

@paulp said:
Honestly they should both be forced to give up "lines". sys.process's should be some name involving stdout or standard out or something which distinguishes the "lines" from stderr, and StringLike should use a name which isn't so likely to collide with the library user's choices.

[scabug]

@som-snytt said:
Yes, process.outputLines, string.linesOfText, plus variants on whether you want autodetect or only NL or only the platform dependent line separator.

I know Rex will make the right naming choices.

OK, since I made the joke, p.outputLines(ending = Auto) [or Newline or EOL]

[scabug]

@Ichoran said:
StringLike gets .lines because it fits right in with .tails .grouped and a bunch of other methods that return iterators. linesIterator is clearly the odd one out, and there's no other modifier that is clearly in.

[scabug]

@Ichoran said:
scala/scala#3453

[SethTisue]

undeprecated for 2.12.7 because of #11125

[som-snytt]

I'd like to add how wise paulp's comment was about naming. linesIterator is lame because it is semantically void.

Edit:
on domain-pertaining naming, which also expresses something about the lines you're getting,
paulp: sys.process's should be some name involving stdout or standard out or something which distinguishes the "lines" from stderr, and StringLike should use a name which isn't so likely to collide with the library user's choices.
me: process.outputLines, string.linesOfText

[adriaanm]

As it turns out, lame names don't get into conflicts.