Skip to content

Commit 6c9c2bb

Browse files
committed
Update specs w/ title meta data and automated TOC
1 parent ded1f63 commit 6c9c2bb

7 files changed

+35
-19
lines changed

doc/specs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: specs
3+
---
4+
5+
@todo Explain what these are, how to write them, why they're needed, etc.

doc/specs/stdlib_experimental_error.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Catching and handling errors
1+
---
2+
title: experimental_error
3+
---
24

3-
* [`check` - Checks the value of a logical condition](#check---checks-the-value-of-a-logical-condition)
4-
* [`error_stop` - aborts the program](#error_stop---aborts-the-program)
5+
# Catching and handling errors
56

7+
[TOC]
68

79
## `check` - Checks the value of a logical condition
810

doc/specs/stdlib_experimental_io.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
---
2+
title: experimental_IO
3+
---
4+
15
# IO
26

3-
* [`loadtxt` - load a 2D array from a text file](#loadtxt---load-a-2d-array-from-a-text-file)
4-
* [`open` - open a file](#open---open-a-file)
5-
* [`savetxt` - save a 2D array into a text file](#savetxt---save-a-2d-array-into-a-text-file)
7+
[TOC]
68

79
## `loadtxt` - load a 2D array from a text file
810

doc/specs/stdlib_experimental_linalg.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
---
2+
title: experimental_linalg
3+
---
4+
15
# Linear Algebra
26

3-
* [`diag` - Create a diagonal array or extract the diagonal elements of an array](#diag---create-a-diagonal-array-or-extract-the-diagonal-elements-of-an-array)
4-
* [`eye` - Construct the identity matrix](#eye---construct-the-identity-matrix)
5-
* [`trace` - Trace of a matrix](#trace---trace-of-a-matrix)
7+
[TOC]
68

79
## `diag` - Create a diagonal array or extract the diagonal elements of an array
810

doc/specs/stdlib_experimental_optval.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
---
2+
title: experimental_optval
3+
---
4+
15
# Default values for optional arguments
26

3-
* [`optval` - fallback value for optional arguments](#optval---fallback-value-for-optional-arguments)
7+
[TOC]
48

59
## `optval` - fallback value for optional arguments
610

doc/specs/stdlib_experimental_quadrature.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
---
2+
title: experimental_quadrature
3+
---
4+
15
# Numerical integration
26

3-
* [`trapz` - integrate sampled values using trapezoidal rule](#trapz---integrate-sampled-values-using-trapezoidal-rule)
4-
* [`trapz_weights` - trapezoidal rule weights for given abscissas](#trapz_weights---trapezoidal-rule-weights-for-given-abscissas)
5-
* [`simps` - integrate sampled values using Simpson's rule (to be implemented)](#simps---integrate-sampled-values-using-simpsons-rule-to-be-implemented)
6-
* [`simps_weights` - Simpson's rule weights for given abscissas (to be implemented)](#simps_weights---simpsons-rule-weights-for-given-abscissas-to-be-implemented)
7+
[TOC]
78

89
## `trapz` - integrate sampled values using trapezoidal rule
910

doc/specs/stdlib_experimental_stats.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Descriptive statistics
1+
---
2+
title: experimental_stats
3+
---
24

3-
* [`cov` - covariance of array elements](#cov---covariance-of-array-elements)
4-
* [`mean` - mean of array elements](#mean---mean-of-array-elements)
5-
* [`moment` - central moments of array elements](#moment---central-moments-of-array-elements)
6-
* [`var` - variance of array elements](#var---variance-of-array-elements)
5+
# Descriptive statistics
76

7+
[TOC]
88

99
## `cov` - covariance of array elements
1010

0 commit comments

Comments
 (0)