Skip to content

Commit 575cf2c

Browse files
committed
docimp: addition of links in md files
1 parent 8c47a35 commit 575cf2c

File tree

5 files changed

+32
-32
lines changed

5 files changed

+32
-32
lines changed

doc/specs/stdlib_experimental_io.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ title: experimental_IO
66

77
[TOC]
88

9-
## `loadtxt` - load a 2D array from a text file
9+
## `[[stdlib_experimental_io(module):loadtxt(interface)]]` - load a 2D array from a text file
1010

1111
### Description
1212
Loads a rank-2 `array` from a text file.
1313

1414
### Syntax
1515

16-
`call loadtxt(filename, array)`
16+
`call [[stdlib_experimental_io(module):loadtxt(interface)]](filename, array)`
1717

1818
### Arguments
1919

@@ -37,15 +37,15 @@ end program demo_loadtxt
3737
```
3838

3939

40-
## `open` - open a file
40+
## `[[stdlib_experimental_io(module):open(function)]]` - open a file
4141

4242
### Description
4343

4444
Returns the unit number of a file opened to read, to write, or to read and write. The file might be a text file or a binary file. All files are opened using a streamed access.
4545

4646
### Syntax
4747

48-
`u = open(filename [, mode] [, iostat])`
48+
`u = [[stdlib_experimental_io(module):open(function)]](filename [, mode] [, iostat])`
4949

5050
### Arguments
5151

@@ -90,14 +90,14 @@ end program demo_open
9090
```
9191

9292

93-
## `savetxt` - save a 2D array into a text file
93+
## `[[stdlib_experimental_io(module):savetxt(interface)]]` - save a 2D array into a text file
9494

9595
### Description
9696
Saves a rank-2 `array` into a text file.
9797

9898
### Syntax
9999

100-
`call savetxt(filename, array)`
100+
`call [[stdlib_experimental_io(module):savetxt(interface)]](filename, array)`
101101

102102
### Arguments
103103

doc/specs/stdlib_experimental_linalg.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ title: experimental_linalg
66

77
[TOC]
88

9-
## `diag` - Create a diagonal array or extract the diagonal elements of an array
9+
## `[[stdlib_experimental_linalg(module):diag(interface)]]` - Create a diagonal array or extract the diagonal elements of an array
1010

1111
### Description
1212

1313
Create a diagonal array or extract the diagonal elements of an array
1414

1515
### Syntax
1616

17-
`d = diag(a [, k])`
17+
`d = [[stdlib_experimental_linalg(module):diag(interface)]](a [, k])`
1818

1919
### Arguments
2020

@@ -91,15 +91,15 @@ program demo_diag5
9191
end program demo_diag5
9292
```
9393

94-
## `eye` - Construct the identity matrix
94+
## `[[stdlib_experimental_linalg(module):eye(function)]]` - Construct the identity matrix
9595

9696
### Description
9797

9898
Construct the identity matrix
9999

100100
## Syntax
101101

102-
`I = eye(n)`
102+
`I = [[stdlib_experimental_linalg(module):eye(function)]](n)`
103103

104104
### Arguments
105105

@@ -128,15 +128,15 @@ program demo_eye2
128128
end program demo_eye2
129129
```
130130

131-
## `trace` - Trace of a matrix
131+
## `[[stdlib_experimental_linalg(module):trace(interface)]]` - Trace of a matrix
132132

133133
### Description
134134

135135
Trace of a matrix (rank-2 array)
136136

137137
### Syntax
138138

139-
`result = trace(A)`
139+
`result = [stdlib_experimental_linalg(module):trace(interface)](A)`
140140

141141
### Arguments
142142

doc/specs/stdlib_experimental_optval.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: experimental_optval
66

77
[TOC]
88

9-
## `optval` - fallback value for optional arguments
9+
## `[[stdlib_experimental_optval(module):optval(interface)]]` - fallback value for optional arguments
1010

1111
### Description
1212

@@ -16,7 +16,7 @@ This function is intended to be called in a procedure with one or more `optional
1616

1717
### Syntax
1818

19-
`result = optval(x, default)`
19+
`result = [[stdlib_experimental_optval(module):optval(interface)]](x, default)`
2020

2121
### Arguments
2222

doc/specs/stdlib_experimental_quadrature.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ title: experimental_quadrature
66

77
[TOC]
88

9-
## `trapz` - integrate sampled values using trapezoidal rule
9+
## `[[stdlib_experimental_quadrature(module):trapz(interface)]]` - integrate sampled values using trapezoidal rule
1010

1111
### Description
1212

1313
Returns the trapezoidal rule integral of an array `y` representing discrete samples of a function. The integral is computed assuming either equidistant abscissas with spacing `dx` or arbitary abscissas `x`.
1414

1515
### Syntax
1616

17-
`result = trapz(y, x)`
17+
`result = [[stdlib_experimental_quadrature(module):trapz(interface)]](y, x)`
1818

19-
`result = trapz(y, dx)`
19+
`result = [[stdlib_experimental_quadrature(module):trapz(interface)]](y, dx)`
2020

2121
### Arguments
2222

@@ -44,18 +44,18 @@ program demo_trapz
4444
! 22.0
4545
print *, trapz(y, 0.5)
4646
! 11.0
47-
end program
47+
end program demo_trapz
4848
```
4949

50-
## `trapz_weights` - trapezoidal rule weights for given abscissas
50+
## `[[stdlib_experimental_quadrature(module):trapz_weights(interface)]]` - trapezoidal rule weights for given abscissas
5151

5252
### Description
5353

5454
Given an array of abscissas `x`, computes the array of weights `w` such that if `y` represented function values tabulated at `x`, then `sum(w*y)` produces a trapezoidal rule approximation to the integral.
5555

5656
### Syntax
5757

58-
`result = trapz_weights(x)`
58+
`result = [[stdlib_experimental_quadrature(module):trapz_weights(interface)]](x)`
5959

6060
### Arguments
6161

@@ -79,7 +79,7 @@ program demo_trapz_weights
7979
w = trapz_weight(x)
8080
print *, dot_product(w, y)
8181
! 22.0
82-
end program
82+
end program demo_trapz_weights
8383
8484
```
8585

doc/specs/stdlib_experimental_stats.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: experimental_stats
66

77
[TOC]
88

9-
## `cov` - covariance of array elements
9+
## `[[stdlib_experimental_stats(module):cov(interface)]]` - covariance of array elements
1010

1111
### Description
1212

@@ -25,7 +25,7 @@ The scaling can be changed with the logical argument `corrected`. If `corrected`
2525

2626
### Syntax
2727

28-
`result = cov(array, dim [, mask [, corrected]])`
28+
`result = [[stdlib_experimental_stats(module):cov(interface)]](array, dim [, mask [, corrected]])`
2929

3030
### Arguments
3131

@@ -62,17 +62,17 @@ program demo_cov
6262
end program demo_cov
6363
```
6464

65-
## `mean` - mean of array elements
65+
## `[[stdlib_experimental_stats(module):mean(interface)]]` - mean of array elements
6666

6767
### Description
6868

6969
Returns the mean of all the elements of `array`, or of the elements of `array` along dimension `dim` if provided, and if the corresponding element in `mask` is `true`.
7070

7171
### Syntax
7272

73-
`result = mean(array [, mask])`
73+
`result = [[stdlib_experimental_stats(module):mean(interface)]](array [, mask])`
7474

75-
`result = mean(array, dim [, mask])`
75+
`result = [[stdlib_experimental_stats(module):mean(interface)]](array, dim [, mask])`
7676

7777
### Arguments
7878

@@ -106,7 +106,7 @@ program demo_mean
106106
end program demo_mean
107107
```
108108

109-
## `moment` - central moments of array elements
109+
## `[[stdlib_experimental_stats(module):moment(interface)]]` - central moments of array elements
110110

111111
### Description
112112

@@ -131,9 +131,9 @@ The _k_-th order moment about `center` is defined as :
131131

132132
### Syntax
133133

134-
`result = moment(array, order [, center [, mask]])`
134+
`result = [[stdlib_experimental_stats(module):moment(interface)]](array, order [, center [, mask]])`
135135

136-
`result = moment(array, order, dim [, center [, mask]])`
136+
`result = [[stdlib_experimental_stats(module):moment(interface)]](array, order, dim [, center [, mask]])`
137137

138138
### Arguments
139139

@@ -173,7 +173,7 @@ program demo_moment
173173
end program demo_moment
174174
```
175175

176-
## `var` - variance of array elements
176+
## `[[stdlib_experimental_stats(module):var(interface)]]` - variance of array elements
177177

178178
### Description
179179

@@ -192,9 +192,9 @@ The use of the term `n-1` for scaling is called Bessel 's correction. The scalin
192192

193193
### Syntax
194194

195-
`result = var(array [, mask [, corrected]])`
195+
`result = [[stdlib_experimental_stats(module):var(interface)]](array [, mask [, corrected]])`
196196

197-
`result = var(array, dim [, mask [, corrected]])`
197+
`result = [[stdlib_experimental_stats(module):var(interface)]](array, dim [, mask [, corrected]])`
198198

199199
### Arguments
200200

0 commit comments

Comments
 (0)