Skip to content

Collection documentation fixes#4651

Closed
vsalvis wants to merge 9 commits intoscala:2.11.xfrom
vsalvis:vsalvis-coll-doc
Closed

Collection documentation fixes#4651
vsalvis wants to merge 9 commits intoscala:2.11.xfrom
vsalvis:vsalvis-coll-doc

Conversation

@vsalvis
Copy link
Contributor

@vsalvis vsalvis commented Jul 21, 2015

Some doc fixes for GenTraversableOnce, methods from aggregate to foreach in alphabetical order. I'm leaving EPFL, so somebody else will have to do the rest of the alphabet ;)

Types of corrections:

  • rewordings, (hopefully) better explanations
  • fixing type params and parameter names so doc gets inherited properly
  • adjusting REPL output to what I get with 2.11
  • moving documentation up to GenTraversableOnce (e.g. copyToArray was defined in GTO, but had no documentation there, only in TraversableLike)
  • squashed some whitespace along the lines

@scala-jenkins scala-jenkins added this to the 2.11.8 milestone Jul 21, 2015
@SethTisue SethTisue self-assigned this Jul 21, 2015
@vsalvis
Copy link
Contributor Author

vsalvis commented Jul 21, 2015

Not sure if the script is general/useful enough to be committed as well? Will look in the failure tomorrow morning.

@vsalvis
Copy link
Contributor Author

vsalvis commented Jul 22, 2015

I'm at a loss... This is the test that's failing: https://github.com/scala-ide/scala-ide/blob/master/org.scala-ide.sdt.debug.expression.tests/src/org/scalaide/debug/internal/expression/features/NewKeywordTest.scala#L55 How can changes to documentation and type parameter names break this test?

@kiritsuku
Copy link
Contributor

Maybe the IDE failure is just a flaky test.

But you are not allowed to just change the parameter names of a function, since they could be called from within user code. At least, you have to annotate them with @deprecateName('previousName)

@lrytz
Copy link
Member

lrytz commented Sep 18, 2015

the changes are good, but we need to revert the parameter name changes. also, i'm not sure about merging this because it fixes only a part of the collection doc (methods a-f) and nobody seems seems to be doing the rest.. @SethTisue what do you think?

@SethTisue
Copy link
Member

I keep hoping someone will magically appear and volunteer to finish it. @janekdb, maybe this one would interest you...?

@janekdb
Copy link
Member

janekdb commented Sep 20, 2015

@SethTisue - Thanks for flagging this one up. I'll spend sometime to see how I can best contribute!

@SethTisue SethTisue removed their assignment Sep 21, 2015
@janekdb
Copy link
Member

janekdb commented Sep 21, 2015

I've created a PR I own to allow me to push, following the guidelines here: https://help.github.com/articles/checking-out-pull-requests-locally/

Kindly let me know if there was a better way of approaching this.

@janekdb janekdb mentioned this pull request Sep 21, 2015
33 tasks
@SethTisue
Copy link
Member

Kindly let me know if there was a better way of approaching this

This is fine. (An alternative would have been to ask @vsalvis for push access to their fork.)

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants