diff --git a/packages/website/docs/Api/DistPointSet.md b/packages/website/docs/Api/DistPointSet.md index 383d251f..b4c4ba81 100644 --- a/packages/website/docs/Api/DistPointSet.md +++ b/packages/website/docs/Api/DistPointSet.md @@ -2,8 +2,9 @@ sidebar_position: 4 title: Point Set Distribution --- + :::danger - These functions aren't yet implemented with these specific names. This should be changed soon +These functions aren't yet implemented with these specific names. This should be changed soon ::: Point set distributions are one of the three distribution formats. They are stored as a list of x-y coordinates representing both discrete and continuous distributions. diff --git a/packages/website/docs/Api/DistSampleSet.md b/packages/website/docs/Api/DistSampleSet.md index 9de3a91f..18005627 100644 --- a/packages/website/docs/Api/DistSampleSet.md +++ b/packages/website/docs/Api/DistSampleSet.md @@ -2,13 +2,14 @@ sidebar_position: 5 title: Sample Set Distribution --- + :::danger - These functions aren't yet implemented with these specific names. This should be added soon. +These functions aren't yet implemented with these specific names. This should be added soon. ::: Sample set distributions are one of the three distribution formats. Internally, they are stored as a list of numbers. It's useful to distinguish point set distributions from arbitrary lists of numbers to make it clear which functions are applicable. -Monte Carlo calculations typically result in sample set distributions. +Monte Carlo calculations typically result in sample set distributions. All regular distribution function work on sample set distributions. In addition, there are several functions that only work on sample set distributions. @@ -44,7 +45,7 @@ SampleSet.map3: (sampleSet, sampleSet, sampleSet, ((number, number, number) => n SampleSet.toList: (sampleSet) => list ``` -Gets the internal samples of a sampleSet distribution. This is separate from the sampleN() function, which would shuffle the samples. toList() maintains order and length. +Gets the internal samples of a sampleSet distribution. This is separate from the sampleN() function, which would shuffle the samples. toList() maintains order and length. **Examples** diff --git a/packages/website/docs/Api/List.md b/packages/website/docs/Api/List.md index 50641a55..47d5f450 100644 --- a/packages/website/docs/Api/List.md +++ b/packages/website/docs/Api/List.md @@ -6,12 +6,12 @@ title: List Squiggle lists are a lot like Python lists or Ruby arrays. They accept all types. ```javascript -myList = [3, normal(5,2), "random"] +myList = [3, normal(5, 2), "random"]; ``` ### make -**Note: currently just called ``makeList``, without the preix** +**Note: currently just called `makeList`, without the preix** ``` List.make: (number, 'a) => list<'a> @@ -39,7 +39,7 @@ length: (list<'a>) => number ### up to -**Note: currently just called ``upTo``, without the preix** +**Note: currently just called `upTo`, without the preix** ``` List.upTo: (low:number, high:number) => list diff --git a/packages/website/docs/Api/Number.mdx b/packages/website/docs/Api/Number.mdx index 4e806426..dda79f64 100644 --- a/packages/website/docs/Api/Number.mdx +++ b/packages/website/docs/Api/Number.mdx @@ -3,7 +3,7 @@ sidebar_position: 9 title: Number --- -Squiggle ``numbers`` are Javascript floats. +Squiggle `numbers` are Javascript floats. Many of the functions below work on lists or pairs of numbers.