Skip to content

Commit 093f1d6

Browse files
aeliassomandolaerik
authored andcommitted
Simplify language and avoid confusing linebreaks in provisional doc
The Markdown compiler got confused by the line starting with :default and interpreted it as a definition list item. Remove such line breaks and simplify the language by splitting each bullet point into two cases, using code blocks instead of inline typewriter text.
1 parent 2dbc204 commit 093f1d6

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

py/dml/provisional.py

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,25 @@ class explicit_param_decls(ProvisionalFeature):
4141
The following new forms are introduced to mark the intent of
4242
declaring a new parameter:
4343
44-
* For typed parameters, `param NAME: TYPE = value;` and `param
45-
NAME: TYPE default value;` are essentially shorthands for `param
46-
NAME: TYPE;` followed by `param NAME = value;` or `param NAME
47-
default value;`.
48-
49-
* For untyped parameters, `param NAME := value;` and `param
50-
:default value;` are essentially shorthands for `param NAME;`
51-
followed by `param NAME = value;` or `param NAME default
52-
value;`.
44+
* For typed parameters, `param NAME: TYPE = value;` is essentially a shorthand for
45+
46+
param NAME: TYPE;
47+
param NAME = value;
48+
49+
and similarly, `param NAME: TYPE default value;` is essentially a shorthand for
50+
51+
param NAME: TYPE;
52+
param NAME default value;
53+
54+
* For untyped parameters, `param NAME := value;` is essentially a shorthand for
55+
56+
param NAME;
57+
param NAME = value;
58+
59+
and similarly `param :default value;` is essentially a shorthand for
60+
61+
param NAME;
62+
param NAME default value;
5363
5464
If one of these forms is used for overriding an existing
5565
parameter, then DMLC will signal an error, because the declaration

0 commit comments

Comments
 (0)