Skip to content

Commit 50d5041

Browse files
committed
fix links in hacker guide and various typos.
1 parent 8efe137 commit 50d5041

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

contribute/bug-reporting-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ If you have a code snippet that is resulting in bytecode which you believe is be
4545

4646
* Keep in mind that the behavior you are witnessing could be intended. Good formal resources for verifying whether or not the language behavior is intended is either in the [Scala Improvement Proposal Documents](http://docs.scala-lang.org/sips/sip-list.html) or in the [Scala Language Specification](http://www.scala-lang.org/docu/files/ScalaReference.pdf). If in doubt, you may always ask on the [scala-internals mailing list](https://groups.google.com/forum/?fromgroups#!forum/scala-internals) or [stackoveflow](http://stackoverflow.com/questions/tagged/scala).
4747

48-
In general, if you find yourself stuck on any of these steps, asking on one of following Scala mailing lists can be helpful:
48+
In general, if you find yourself stuck on any of these steps, asking on one of the following Scala mailing lists can be helpful:
4949

5050
- For unexpected behavior use [scala-language](https://groups.google.com/forum/?fromgroups#!forum/scala-language), or [scala-user](https://groups.google.com/forum/?fromgroups#!forum/scala-user) mailing lists.
5151
- For compiler bugs use the [scala-internals](https://groups.google.com/forum/?fromgroups#!forum/scala-internals) mailing list.
@@ -84,4 +84,4 @@ In the description of your issue, be as detailed as you can. Bug reports which h
8484
2. The expected output.
8585
3. The actual output, including the stacktrace.
8686
4. Related discussion on the mailing lists, if applicable.
87-
4. If you have already looked into the issue provide interesting insights or proposals for fixing the issue.
87+
4. If you have already looked into the issue provide interesting insights or proposals for fixing the issue.

contribute/hacker-guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This is the list of language features/libraries along with their maintainers's f
3737
Since Martin is the person who submitted the string interpolation Scala Improvement Proposal and implemented this language feature for Scala 2.10.0, he might be interested in learning of new bugfixes to that feature.
3838

3939
As alluded to earlier, one must also choose an appropriate mailing list. Typically, one would use the scala-internals mailing list, as it is devoted to discussions about the core internal design and implementation of the Scala system. However, since this issue has been discussed previously on the scala-user mailing list,
40-
in this example, we post to the [the scala-user mailing list](http://groups.google.com/group/scala-user)about our issue.
40+
in this example, we post to the [the scala-user mailing list](http://groups.google.com/group/scala-user) about our issue.
4141

4242
<center><img src="{{ site.baseurl }}/resources/img/01-post.png" alt="Posting to scala-user" /></center>
4343
<br/>
@@ -143,7 +143,7 @@ Both Eclipse and IntelliJ IDEA have Scala plugins, which are known to work with
143143
[instructions for Intellij](https://github.com/scala/scala/blob/master/src/intellij/README). Both of those Scala plugins provide
144144
navigation, refactoring and error reporting functionality as well as integrated debugging.
145145

146-
There also exist lighter-weight editors such as Emacs, Sublime or jEdit which provide unparalleled are faster and much less memory/compute-intensive to run, while
146+
There also exist lighter-weight editors such as Emacs, Sublime or jEdit which are faster and much less memory/compute-intensive to run, while
147147
lacking semantic services and debugging. To address this shortcoming, they can integrate with ENSIME,
148148
a helper program, which hosts a resident Scala compiler providing some of the features implemented in traditional IDEs. However despite
149149
having significantly matured over the last year, support for our particular code base is still being improved, and is not as mature as for Eclipse and IntelliJ.
@@ -194,11 +194,11 @@ There are several areas that one could contribute to-- there is the Scala librar
194194

195195
##### The Scala Library
196196

197-
Contributing to the Scala standard library is about the same as working on one of your own libraries. Beyond the Scala collections hierarchy, there are no complex internals or architectures to have to worry about. Just make sure that you code in a "don't-repeat-yourself" (DRY) style, obeying the "boy scout principle" (i.e. make sure you've left something cleaner than you found it.)
197+
Contributing to the Scala standard library is about the same as working on one of your own libraries. Beyond the Scala collections hierarchy, there are no complex internals or architectures to have to worry about. Just make sure that you code in a "don't-repeat-yourself" (DRY) style, obeying the "boy scout principle" (i.e. make sure you've left something cleaner than you found it).
198198

199199
If documentation is necessary for some trait/class/object/method/etc in the Scala standard library, typically maintainers will include inline comments describing their design decisions or rationale for implementing things the way they have, if it is not straightforward.
200200

201-
If you intend on contributing to Scala collections, please make sure you're familiar with the design of the Scala collections library. It can be easy to put an implementation in the wrong location if you are unfamiliar with the collections architecture. There is an excellent and very detailed guide covering [the Architecture of Scala Collections](http://docs.scala-lang.org/overviews/core/architecture-of-scala-collections.html), as well as a larger more general [Scala collections Guide](http://docs.scala-lang.org/overviews/core/collections.html) covering the sequential portion of collections. For parallel collections, there also exists a detailed [Scala Parallel Collections Guide](http://docs.scala-lang.org/overviews/core/parallel-collections.html). (TODO double check these links!)
201+
If you intend on contributing to Scala collections, please make sure you're familiar with the design of the Scala collections library. It can be easy to put an implementation in the wrong location if you are unfamiliar with the collections architecture. There is an excellent and very detailed guide covering [the Architecture of Scala Collections](http://docs.scala-lang.org/overviews/core/architecture-of-scala-collections.html), as well as a larger more general [Scala collections Guide](http://docs.scala-lang.org/overviews/collections/introduction.html) covering the sequential portion of collections. For parallel collections, there also exists a detailed [Scala Parallel Collections Guide](http://docs.scala-lang.org/overviews/parallel-collections/overview.html).
202202

203203
##### The Scala Compiler
204204

@@ -272,9 +272,9 @@ I have already written one test earlier, so that's a good start but not enough!
272272

273273
Adding tests to the test suite is as easy as moving them to the appropriate directory:
274274

275-
* Code which should compile successfully, but doesn't need to be executed, needs to go into the [“pos” directory](https://github.com/scala/scala/tree/master/test/files/pos)
276-
* Code which should not compile needs to go into the [“neg” directory](https://github.com/scala/scala/tree/master/test/files/neg)
277-
* Code which should compile and get executed by the test suite needs to go into the [“run” directory](https://github.com/scala/scala/tree/master/test/files/run)
275+
* Code which should compile successfully, but doesn't need to be executed, needs to go into the [“pos” directory](https://github.com/scala/scala/tree/master/test/files/pos).
276+
* Code which should not compile needs to go into the [“neg” directory](https://github.com/scala/scala/tree/master/test/files/neg).
277+
* Code which should compile and get executed by the test suite needs to go into the [“run” directory](https://github.com/scala/scala/tree/master/test/files/run).
278278

279279
### Verify
280280

0 commit comments

Comments
 (0)