1
0
Fork 0

fix(markdown): Change optional parameter doc format from man page to JavaScript

This commit is contained in:
Benjamin Fan 2024-02-11 06:39:10 -08:00
parent bf4b4c8755
commit c2d5b943b6
6 changed files with 7 additions and 7 deletions

View file

@ -7,7 +7,7 @@ The `Path.addText()` method adds text to the path.
## Signature ## Signature
```js ```js
Path path.addText(string text[, string className]) Path path.addText(string text, string className = '')
``` ```
The second argument will optionally be used to set the CSS class for the text. The second argument will optionally be used to set the CSS class for the text.

View file

@ -13,8 +13,8 @@ instead, thereby overwriting the value of the attribute.
```js ```js
Path path.attr( Path path.attr(
string name, string name,
mixed value[, mixed value,
bool overwrite = false] bool overwrite = false
) )
``` ```

View file

@ -12,7 +12,7 @@ If that's not what you want, you should use
## Signature ## Signature
```js ```js
Path path.join(path other[, bool closed=false]) Path path.join(path other, bool closed = false)
``` ```
The second argument will optionally be used to close the joined path. The second argument will optionally be used to close the joined path.

View file

@ -7,7 +7,7 @@ The `Path.setText()` method sets text on the path.
## Signature ## Signature
```js ```js
Path path.setText(string text[, string className]) Path path.setText(string text, string className = '')
``` ```
The second argument will optionally be used to set the CSS class for the text. The second argument will optionally be used to set the CSS class for the text.

View file

@ -8,7 +8,7 @@ along the path.
## Signature ## Signature
```js ```js
Point path.shiftAlong(float distance[, int stepsPerMm=10]) Point path.shiftAlong(float distance, int stepsPerMm = 10)
``` ```
The second parameter controls the precision by which the path will be _walked_. The second parameter controls the precision by which the path will be _walked_.

View file

@ -8,7 +8,7 @@ length of the path travelled along the path.
## Signature ## Signature
```js ```js
Point path.shiftFractionAlong(float fraction[, int stepsPerMm=25]) Point path.shiftFractionAlong(float fraction, int stepsPerMm = 25)
``` ```
The second parameter controls the precision by which the path will be _walked_. The second parameter controls the precision by which the path will be _walked_.