Skip to content

Commit 6d7efb5

Browse files
committed
Merge pull request scala#471 from janekdb/master
Fix markdown example for italic and bold
2 parents 0741722 + 6896b70 commit 6d7efb5

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

overviews/scaladoc/for-library-authors.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ that starts with a `/**` and ends with a `*/`, like this:
3737
* left margin is on the same column on the
3838
* first line and on subsequent ones.
3939
*
40-
* The closing scaladoc tag goes on its own,
40+
* The closing Scaladoc tag goes on its own,
4141
* separate line. E.g.
4242
*
4343
* Calculate the square of the given number
@@ -71,7 +71,7 @@ include:
7171
- `@return` detail the return value from a method (one per method).
7272

7373

74-
### Constructor and/or Class tags
74+
### Method, Constructor and/or Class tags
7575
- `@throws` what exceptions (if any) the method or constructor may throw.
7676
- `@param` detail a value parameter for a method or constructor, provide one
7777
per parameter to the method/constructor.
@@ -118,7 +118,7 @@ If a comment is not provided for an entity at the current inheritance level, but
118118
is supplied for the overridden entity at a higher level in the inheritance
119119
hierarchy, the comment from the super-class will be used.
120120

121-
Likewise if `@param`, `@tparam`, `@return` and other entity tags are ommitted
121+
Likewise if `@param`, `@tparam`, `@return` and other entity tags are omitted
122122
but available from a superclass, those comments will be used.
123123

124124
### Explicit
@@ -133,8 +133,8 @@ not necessary most of the time as Markdown styles may be used instead.
133133
Some of the standard Markdown formatting available:
134134

135135
`monospace`
136-
``italic text``
137-
```bold text```
136+
''italic text''
137+
'''bold text'''
138138
__underline__
139139
^superscript^
140140
,,subscript,,

overviews/scaladoc/interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ may not have known about already, here are a few key points.
5151
- By expanding linear supertypes triangle, you can see the linearized trait
5252
definitions for the current class, trait or object.
5353
- Known subclasses lists all subclasses for this entity within the current
54-
scaladoc.
54+
Scaladoc.
5555
- Type hierarchy shows a graphical view of this class related to its super
5656
classes and traits, immediate sub-types, and important related entities. The
5757
graphics themselves are links to the various entities.

0 commit comments

Comments
 (0)