Skip to content

Commit 2a9b815

Browse files
committed
Add settings.md in russian
1 parent 0fea7cd commit 2a9b815

File tree

2 files changed

+97
-84
lines changed

2 files changed

+97
-84
lines changed

_overviews/scala3-scaladoc/settings.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,18 @@ Example source links is:
5353

5454
Accepted formats:
5555

56-
\<sub-path>=\<source-link>
57-
\<source-link>
56+
`<sub-path>=<source-link>`
5857

59-
where \<source-link> is one of following:
58+
where `<source-link>` is one of following:
6059
- `github://<organization>/<repository>[/revision][#subpath]`
6160
will match https://github.com/$organization/$repository/\[blob|edit]/$revision\[/$subpath]/$filePath\[$lineNumber]
6261
when revision is not provided then requires revision to be specified as argument for scaladoc
6362
- `gitlab://<organization>/<repository>`
6463
will match https://gitlab.com/$organization/$repository/-/\[blob|edit]/$revision\[/$subpath]/$filePath\[$lineNumber]
6564
when revision is not provided then requires revision to be specified as argument for scaladoc
66-
- \<scaladoc-template>
65+
- `<scaladoc-template>`
6766

68-
\<scaladoc-template> is a format for `doc-source-url` parameter from old scaladoc.
67+
`<scaladoc-template>` is a format for `doc-source-url` parameter from old scaladoc.
6968
NOTE: We only supports `€{FILE_PATH_EXT}`, `€{TPL_NAME}`, `€{FILE_EXT}`,
7069
`€{FILE_PATH}`, and `€{FILE_LINE}` patterns.
7170

@@ -82,15 +81,15 @@ Mapping between regexes matching classpath entries and external documentation.
8281
Example external mapping is:
8382
`-external-mappings:.*scala.*::scaladoc3::https://scala-lang.org/api/3.x/,.*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/`
8483

85-
A mapping is of the form '\<regex>::\[scaladoc3|scaladoc|javadoc]::\<path>'. You can supply several mappings, separated by commas, as shown in the example.
84+
A mapping is of the form `<regex>::[scaladoc3|scaladoc|javadoc]::<path>`. You can supply several mappings, separated by commas, as shown in the example.
8685

8786
##### -social-links
8887

8988
Links to social sites. For example:
9089

9190
`-social-links:github::https://github.com/lampepfl/dotty,discord::https://discord.com/invite/scala,twitter::https://twitter.com/scala_lang`
9291

93-
Valid values are of the form: `\[github|twitter|gitter|discord]::link`. Scaladoc also supports `custom::link::white_icon_name::black_icon_name`. In this case icons must be present in `images/` directory.
92+
Valid values are of the form: `[github|twitter|gitter|discord]::link`. Scaladoc also supports `custom::link::white_icon_name::black_icon_name`. In this case icons must be present in `images/` directory.
9493

9594
##### -skip-by-id
9695

@@ -157,9 +156,9 @@ where `path` is a prefix of the path to source files where snippets are located
157156
If the path is not present, the argument will be used as the default for all unmatched paths.
158157

159158
Available flags:
160-
compile - Enables snippet checking.
161-
nocompile - Disables snippet checking.
162-
fail - Enables snippet checking, asserts that snippet doesn't compile.
159+
- compile - Enables snippet checking.
160+
- nocompile - Disables snippet checking.
161+
- fail - Enables snippet checking, asserts that snippet doesn't compile.
163162

164163
The fail flag comes in handy for snippets that present that some action would eventually fail during compilation, e. g. [Opaques page]({{ site.scala3ref }}/other-new-features/opaques.html)
165164

@@ -169,9 +168,9 @@ Example usage:
169168

170169
Which means:
171170

172-
all snippets in files under directory `my/path/nc` should not be compiled at all
173-
all snippets in files under directory `my/path/f` should fail during compilation
174-
all other snippets should compile successfully
171+
- all snippets in files under directory `my/path/nc` should not be compiled at all
172+
- all snippets in files under directory `my/path/f` should fail during compilation
173+
- all other snippets should compile successfully
175174

176175
##### -Ysnippet-compiler-debug
177176

0 commit comments

Comments
 (0)