Skip to content

Commit add60f3

Browse files
committed
final proof read
1 parent d8e9d2e commit add60f3

File tree

8 files changed

+89
-93
lines changed

8 files changed

+89
-93
lines changed

_overviews/contribute/add-guides.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ num: 7
66
## Why Contribute New Learning Material?
77

88
As [Heather Miller writes][why-contribute], contributing to [docs.scala-lang.org][home] is
9-
critical to making Scala accessible to newcomers, experience programmers, and anyone who is curious.
9+
critical to making Scala accessible to newcomers, experienced programmers, and anyone who is curious.
1010
It is also a fantastic way to contribute for anyone who is comfortable using Scala, but maybe does not want to get
1111
involved with complex tools like the compiler.
1212

@@ -45,7 +45,7 @@ To use this feature you must use the backtick notation as documented by mdoc,
4545

4646
## Submitting Docs
4747

48-
For you to contribute a document, first
48+
To contribute a new document, you should first
4949
[fork](https://help.github.com/articles/fork-a-repo/) the
5050
[repo](https://github.com/scala/docs.scala-lang), then write your article in
5151
[Markdown](https://daringfireball.net/projects/markdown/syntax) (example below), and finally submit a pull request.
@@ -87,7 +87,7 @@ is provided.
8787
The goal of this documentation repository is to be highly curated, rather than the approach by other community-driven
8888
documentation platforms, like wikis. Therefore, to be included on [docs.scala-lang.org][home], a document must:
8989

90-
- **"fit in"** to the repository ( _i.e.,_ it should not be a complete duplicate of another article),
90+
- **"fit in"** to the repository (_i.e.,_ it should not be a complete duplicate of another article),
9191
- **be polished**, i.e. it must be thorough, complete, correct, and organized; written as an article to be understood
9292
by many users.
9393
- **be maintained**, if the document might require revisions from time to time, be prepared to keep it up to date, or
@@ -100,8 +100,6 @@ clarifications, etc.
100100

101101
## Document Templates
102102

103-
> **Note:** These templates will soon change slightly as a result of necessary refactoring.
104-
105103
### Guides/Overviews
106104

107105
A guide or an overview that can be logically placed on **one** markdown page should be placed in the directory
@@ -215,16 +213,14 @@ snippet and ensures that it's valid.
215213
<pre class="highlight">
216214
<code class="hljs scala">&#96;&#96;&#96;scala mdoc
217215
<span class="hljs-keyword">val</span> a = <span class="hljs-number">1</span>
218-
&#96;&#96;&#96;
219-
</code></pre></div></div>
216+
```</code></pre></div></div>
220217
221218
If you have a snippet that you expect to fail, you can also account for this by
222219
using `mdoc:fail` for a compile error `mdoc:crash` for a runtime-error.
223220
224221
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code class="hljs scala">&#96;&#96;&#96;scala mdoc:fail
225222
<span class="hljs-keyword">val</span> b: <span class="hljs-type">String</span> = <span class="hljs-number">3</span> <span class="hljs-comment">// won't compile</span>
226-
```
227-
</code></pre></div></div>
223+
```</code></pre></div></div>
228224
229225
Keep in mind that a single file is all compiled as a single unit, so you can't
230226
redefine a variable that was defined above in another code snippet. _However_
@@ -239,28 +235,23 @@ above. Here is an example using the various modifiers.
239235
240236
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">now</span></span>() = <span class="hljs-type">Instant</span>.now()
241237
<span class="hljs-class"><span class="hljs-keyword">object</span> <span class="hljs-title">Foo</span> </span>{}
242-
```
243-
</code></pre></div></div>
238+
```</code></pre></div></div>
244239
245240
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code class="hljs scala">&#96;&#96;&#96;scala mdoc:nest
246241
<span class="hljs-keyword">case</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Foo</span>(<span class="hljs-params">a: <span class="hljs-type">Int</span></span>) <span class="hljs-comment">// conflicts with Foo above, but it's nested so it's fine</span></span>
247-
```
248-
</code></pre></div></div>
242+
```</code></pre></div></div>
249243
250244
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code class="hljs scala">&#96;&#96;&#96;scala mdoc
251245
<span class="hljs-keyword">val</span> a = <span class="hljs-string">s"The time is <span class="hljs-subst">${now()}</span>"</span> <span class="hljs-comment">// still have access to the now method from above</span>
252-
```
253-
</code></pre></div></div>
246+
```</code></pre></div></div>
254247
255248
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code class="hljs scala">&#96;&#96;&#96;scala mdoc:reset
256249
<span class="hljs-keyword">case</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Foo</span>(<span class="hljs-params">a: <span class="hljs-type">String</span></span>) <span class="hljs-comment">// forget the previous Foo's and start fresh</span></span>
257-
```
258-
</code></pre></div></div>
250+
```</code></pre></div></div>
259251
260252
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code class="hljs scala">&#96;&#96;&#96;scala mdoc
261253
<span class="hljs-keyword">val</span> myFoo = <span class="hljs-type">Foo</span>(<span class="hljs-string">"hi"</span>) <span class="hljs-comment">// now we only have access to the last Foo</span>
262-
```
263-
</code></pre></div></div>
254+
```</code></pre></div></div>
264255
265256
[collections-overview]: {% link _overviews/collections-2.13/introduction.md %}
266257
[why-contribute]: {% link contribute.md %}

_overviews/contribute/bug-reporting-guide.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@ title: Bug Reporting Guide
33
num: 8
44
---
55

6-
The Scala compiler and standard library bug tracker is located at [https://github.com/scala/bug](https://github.com/scala/bug), and for Scala 3, it is located at [github.com/lampepfl/dotty](https://github.com/lampepfl/dotty/issues). Before you submit a bug make sure that it is certainly a bug by following instructions in *Is it a Bug?*.
6+
The Scala compiler and standard library bug tracker is located at [https://github.com/scala/bug](https://github.com/scala/bug), and for Scala 3, it is located at [github.com/lampepfl/dotty](https://github.com/lampepfl/dotty/issues). Before you submit a bug make sure that it is certainly a bug by following instructions
7+
in [Is it a Bug?](#is-it-a-bug).
78

89
## Is it a Bug?
910

1011
The first step in identifying a bug is to identify which component of the Scala distribution is affected. First, ensure that your issue falls within any of the following categories:
1112

1213
- **Library** bugs typically manifest themselves as run-time exceptions, or as *unexpected*/*unintuitive* behavior of Scala Standard Library methods.
1314
- **Compiler** errors are manifested as compile time exceptions, unexpected behavior of your code at run time, or invalid behavior of the type system.
14-
- **Reflection** are bugs that appear in the scala.reflect package. For the *reflection* bugs , the same rules apply as for the *library* bugs.
15+
- **Reflection** are bugs that appear in the `scala.reflect` package. For the *reflection* bugs, the same rules apply as for the *library* bugs.
1516
- **Scaladoc** bugs are manifested as a logical problems in the information it presents (that is, the displayed information is incorrect, such as an incorrect subclassing relationship), or incorrect behavior of the user interface. If you'd like to suggest a change in the content of the documentation, please submit a pull request (possible to do in the browser using GitHub, which is easier and faster than filing a bug). Please file a bug about the content of documentation only if you cannot provide a suggestion for its fix.
1617

1718
If your issue is related to any of the following external projects, make sure to use its appropriate issue tracker:
@@ -31,13 +32,13 @@ If you have a code snippet that is resulting in bytecode which you believe is be
3132

3233
* Make sure you minimize your problem. To correctly minimize the problem follow the following instructions:
3334

34-
1. Gradually take apart the offensive code snippet until you believe you have the simplest representation of your problem.
35+
1. Gradually remove parts from the original failing code snippet until you believe you have the simplest representation of your problem.
3536

36-
2. Ensure that you have decoupled your code snippet from any library that could be introducing the offensive behavior. One way to achieve this is to try to recompile the offensive code snippet in isolation, outside of the context of any complex build environment. If your code depends on some strictly Java library and source code is available for it, make sure that the latter is also minimized.
37+
2. Ensure that you have decoupled your code snippet from any library that could be introducing the incorrect behavior. One way to achieve this is to try to recompile the offending code snippet in isolation, outside of the context of any complex build environment. If your code depends on some strictly Java library and source code is available for it, make sure that the latter is also minimized.
3738

3839
3. Make sure you are compiling your project from a clean slate. Your problem could be related to separate compilation, which is difficult to detect without a clean build with new `.class` files.
3940

40-
4. If you have encountered a bug while building your code in the IDE, then please reproduce it on the command line. The same rule applies for build tools like `sbt` or `ant`.
41+
4. If you have encountered a bug while building your code in the IDE, then please reproduce it on the command line. The same rule applies for build tools like **sbt** or **Mill**.
4142

4243
5. If you want to file an improvement in the issue tracker please discuss it first on one of the mailing lists. They offer much bigger audience than issue tracker. The latter is not suitable for long discussions.
4344

@@ -69,7 +70,7 @@ Please make sure to fill in as many fields as possible. Make sure you've indicat
6970
3. **Labels** related to your issue. For example, if you think your issue is related to the typechecker, and if you have successfully minimized your issue, label your bug as "typechecker" and "minimized". Issue tracker will suggest names for existing labels as you type them so try not to create duplicates.
7071
4. **Running environment**. Are you running on Linux? Windows? What JVM version are you using?
7172

72-
In order for us to quickly triage the bug that you've found, it's important that the code snippet which produces the observed issue is as minimized as possible. For advice on minimizing your code snippet, please see the appropriate subsection of the above (Is it a Bug?).
73+
In order for us to quickly triage the bug that you've found, it's important that the code snippet which produces the observed issue is as minimized as possible. For advice on minimizing your code snippet, please see the appropriate subsection of the above ([Is it a Bug?](#is-it-a-bug)).
7374

7475
### Description
7576

_overviews/contribute/corelibs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ There are several options for contributing to Scala's core libraries. You can:
1414
### Significant changes
1515

1616
For significant new functionality or a whole new API to be considered for inclusion in the core Scala distribution,
17-
please take into account [https://github.com/scala/scala-dev/issues/661] before doing so.
17+
please take into account [scala/scala-dev#661](https://github.com/scala/scala-dev/issues/661) before doing so.
1818

1919
[documentation]: {% link _overviews/contribute/documentation.md %}
2020
[bug-reporting-guide]: {% link _overviews/contribute/bug-reporting-guide.md %}

_overviews/contribute/documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ num: 5
77
There are several ways you can help out with the improvement of Scala documentation. These include:
88

99
* API Documentation in Scaladoc
10-
* Guides, Overviews, Tutorials, Cheat Sheets and more on the docs.scala-lang.org site
11-
* Updating scala-lang.org
10+
* Guides, Overviews, Tutorials, Cheat Sheets and more on the [docs.scala-lang.org][home] site
11+
* Updating [scala-lang.org](https://scala-lang.org)
1212

13-
Please read this page, and the pages linked from this one, fully before contributing documentation. Many of the questions you have will be answered in these resources. If you have a question that isn't answered, feel free to ask on the [Scala Contributors](https://contributors.scala-lang.org/) mailing list and then, please, submit a pull request with updated documentation reflecting that answer.
13+
Please read this page, and the pages linked from this one, fully before contributing documentation. Many frequently asked questions will be answered in these resources. If you have a question that isn't answered, feel free to ask on the [Scala Contributors](https://contributors.scala-lang.org/) forum and then, please, submit a pull request with updated documentation reflecting that answer.
1414

1515
**General requirements** for documentation submissions include spell-checking all written language, ensuring code samples compile and run correctly, correct grammar, and clean formatting/layout of the documentation.
1616

_overviews/contribute/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ num: 10
1818
Just to name a few common reasons:
1919

2020
* contributing a patch is the best way to make sure your desired changes will be available in the next Scala version
21-
* Scala is written in Scala, so going through the source code and patching it will improve your Scala-fu
21+
* Scala is written in Scala, so going through the source code and patching it will improve your knowledge of Scala.
2222
* last but not least, it only takes a few accepted commits to make it into the [Scala Contributor Hall of Fame](https://github.com/scala/scala/contributors).
2323

2424
The main Scala project consists of the standard Scala library, the Scala reflection and macros library,

0 commit comments

Comments
 (0)