Skip to content

Commit 0bd2073

Browse files
committed
Update readme
1 parent b1cf6a9 commit 0bd2073

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/_spec/README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Scala Language Reference
1+
# WIP Scala 3 Language Specification
2+
3+
**This is still a work in progress, and should *not* be regarded as a source of truth.**
24

35
First of all, the language specification is meant to be correct, precise and clear.
46

@@ -16,9 +18,6 @@ We aim to track the configuration GitHub Pages uses but differences may arise as
1618

1719
## Building
1820

19-
<!-- TODO: change url to correct one -->
20-
Travis CI builds the spec automatically after every merged pull release and publishes to https://www.scala-lang.org/files/archive/spec/2.13/.
21-
2221
<!-- TODO: Check nothing else is needed -->
2322
To preview locally, run the following commands in the docs/_spec subfolder:
2423

@@ -40,8 +39,16 @@ and open http://0.0.0.0:4000/ to view the spec. Jekyll will rebuild as you edit
4039
- MathJAX errors will appear within the rendered DOM as span elements with class `mtext` and style attribute `color: red` applied. It is possible to search for this combination in the development tools of the browser of your choice. In chrome, CTRL+F / CMD+F within the inspect element panel allows you to do this.
4140

4241
- This document follows the "one sentence <=> one line" convention, with the following exceptions below.
43-
- - A multiline code bloc is part of the sentence
44-
- - An enumeration of links is long enough
42+
- A multiline code bloc is part of the sentence
43+
- An enumeration of links is long enough
44+
45+
- Whenever doing an enumeration of the kind "a, ..., z", follow the following conventions:
46+
- It should always be "separator whitespace period period period separator whitespace", for example `, ..., ` or `,\n...,\n` for multiline.
47+
- If in a code block, only the elements (a and z above) should be in math mode (between forward ticks)
48+
- If in a math expression, the whole thing should be in a single math mode
49+
- Look at the [Tuple Types section](docs/_spec/03-types.html#tuple-types) for an example of the different cases above.
50+
51+
- Try to use "Note" blocs to point out logical conclusions that are not obvious, for examples, look at the [Tuple Types section](docs/_spec/03-types.html#tuple-types).
4552

4653
### Macro replacements:
4754

@@ -51,7 +58,7 @@ and open http://0.0.0.0:4000/ to view the spec. Jekyll will rebuild as you edit
5158
- As MathJAX has no support for slanted font (latex command \sl), so in all instances this should be replaced with \mathit{}
5259
- The macro \U{ABCD} used for unicode character references can be replaced with \\uABCD.
5360
- The macro \URange{ABCD}{DCBA} used for unicode character ranges can be replaced with \\uABCD-\\uDBCA.
54-
- The macro \commadots can be replaced with ` , … , `.
61+
- The macro \commadots can be replaced with ` , … , ` (But should not, see above).
5562
- There is no adequate replacement for `\textsc{...}` (small caps) in pandoc markdown. While unicode contains a number of small capital letters, it is notably missing Q and X as these glyphs are intended for phonetic spelling, therefore these cannot be reliably used. For now, the best option is to use underscore emphasis and capitalise the text manually, `_LIKE THIS_`.
5663

5764
### Unicode Character replacements

0 commit comments

Comments
 (0)