Skip to content

Commit a4f0791

Browse files
committed
toc_md: addition of TOC in Markdown files
1 parent 42af7d5 commit a4f0791

File tree

3 files changed

+59
-9
lines changed

3 files changed

+59
-9
lines changed

src/stdlib_experimental_io.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,28 @@
22

33
## Implemented
44

5-
* `loadtxt`
6-
* `open`
7-
* `savetxt`
8-
5+
<!-- vim-markdown-toc GFM -->
6+
7+
* [`loadtxt` - load a 2D array from a text file](#loadtxt---load-a-2d-array-from-a-text-file)
8+
* [Description](#description)
9+
* [Syntax](#syntax)
10+
* [Arguments](#arguments)
11+
* [Return value](#return-value)
12+
* [Example](#example)
13+
* [`open` - open a file](#open---open-a-file)
14+
* [Description](#description-1)
15+
* [Syntax](#syntax-1)
16+
* [Arguments](#arguments-1)
17+
* [Return value](#return-value-1)
18+
* [Example](#example-1)
19+
* [`savetxt` - save a 2D array into a text file](#savetxt---save-a-2d-array-into-a-text-file)
20+
* [Description](#description-2)
21+
* [Syntax](#syntax-2)
22+
* [Arguments](#arguments-2)
23+
* [Output](#output)
24+
* [Example](#example-2)
25+
26+
<!-- vim-markdown-toc -->
927

1028
## `loadtxt` - load a 2D array from a text file
1129

src/stdlib_experimental_optval.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,17 @@
22

33
## Implemented
44

5-
* `optval`
5+
6+
<!-- vim-markdown-toc GFM -->
7+
8+
* [`optval` - fallback value for optional arguments](#optval---fallback-value-for-optional-arguments)
9+
* [Description](#description)
10+
* [Syntax](#syntax)
11+
* [Arguments](#arguments)
12+
* [Return value](#return-value)
13+
* [Example](#example)
14+
15+
<!-- vim-markdown-toc -->
616

717
## `optval` - fallback value for optional arguments
818

src/stdlib_experimental_quadrature.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,30 @@
22

33
## Implemented
44

5-
* `trapz`
6-
* `trapz_weights`
5+
<!-- vim-markdown-toc GFM -->
6+
7+
* [`trapz` - integrate sampled values using trapezoidal rule](#trapz---integrate-sampled-values-using-trapezoidal-rule)
8+
* [Syntax](#syntax)
9+
* [Arguments](#arguments)
10+
* [Return value](#return-value)
11+
* [Example](#example)
12+
* [`trapz_weights` - trapezoidal rule weights for given abscissas](#trapz_weights---trapezoidal-rule-weights-for-given-abscissas)
13+
* [Syntax](#syntax-1)
14+
* [Arguments](#arguments-1)
15+
* [Return value](#return-value-1)
16+
* [Example](#example-1)
17+
* [`simps` - integrate sampled values using Simpson's rule (to be implemented)](#simps---integrate-sampled-values-using-simpsons-rule-to-be-implemented)
18+
* [Syntax](#syntax-2)
19+
* [Arguments](#arguments-2)
20+
* [Return value](#return-value-2)
21+
* [Example](#example-2)
22+
* [`simps_weights` - Simpson's rule weights for given abscissas (to be implemented)](#simps_weights---simpsons-rule-weights-for-given-abscissas-to-be-implemented)
23+
* [Syntax](#syntax-3)
24+
* [Arguments](#arguments-3)
25+
* [Return value](#return-value-3)
26+
* [Example](#example-3)
27+
28+
<!-- vim-markdown-toc -->
729

830
## `trapz` - integrate sampled values using trapezoidal rule
931

@@ -78,7 +100,7 @@ end program
78100
79101
```
80102

81-
# `simps` - integrate sampled values using Simpson's rule
103+
# `simps` - integrate sampled values using Simpson's rule (to be implemented)
82104

83105
Returns the Simpson's 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`.
84106

@@ -112,7 +134,7 @@ If the size of `y` is two, the result is the same as if `trapz` had been called
112134

113135
TBD
114136

115-
# `simps_weights` - Simpson's rule weights for given abscissas
137+
# `simps_weights` - Simpson's rule weights for given abscissas (to be implemented)
116138

117139
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 Simpson's rule approximation to the integral.
118140

0 commit comments

Comments
 (0)