From 62fd64817a66d4ae506fa1dc7b633b69735dbc2c Mon Sep 17 00:00:00 2001 From: Nuno Fachada Date: Sun, 22 Jan 2023 00:34:12 +0000 Subject: [PATCH] Small improvements to the documentation --- docs/src/examples.md | 10 +++++----- docs/src/index.md | 16 ++++++++-------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/src/examples.md b/docs/src/examples.md index ee7fbde..5edefa3 100644 --- a/docs/src/examples.md +++ b/docs/src/examples.md @@ -15,13 +15,13 @@ and omit the PRNG altogether, or use a built-in PRNG such as the [Mersenne Twister](https://docs.julialang.org/en/v1/stdlib/Random/#Random.MersenneTwister). The plots of each example are generated with helper functions available -[here](https://github.com/clugen/CluGen.jl/blob/master/docs/CluGenExtras.jl). +[here](https://github.com/clugen/CluGen.jl/blob/main/docs/CluGenExtras.jl). ## 2D examples The 2D examples were plotted with the `plot_examples_2d()` helper function, available -[here](https://github.com/clugen/CluGen.jl/blob/master/docs/CluGenExtras.jl). +[here](https://github.com/clugen/CluGen.jl/blob/main/docs/CluGenExtras.jl). For plotting an example directly, e.g. for `e01`, run: ```julia @@ -428,7 +428,7 @@ nothing # hide The 3D examples were plotted with the `plot_examples_3d()` helper function available -[here](https://github.com/clugen/CluGen.jl/blob/master/docs/CluGenExtras.jl). +[here](https://github.com/clugen/CluGen.jl/blob/main/docs/CluGenExtras.jl). For plotting an example directly, e.g. for `e40`, run: ```julia @@ -836,7 +836,7 @@ nothing # hide #### Basic 1D example with density plot The following example was plotted with the `plot_examples_1d()` function available -[here](https://github.com/clugen/CluGen.jl/blob/master/docs/CluGenExtras.jl). +[here](https://github.com/clugen/CluGen.jl/blob/main/docs/CluGenExtras.jl). ```julia # Custom proj_dist_fn: point projections placed using the Laplace distribution @@ -886,7 +886,7 @@ nothing # hide #### 5D example with default optional arguments The following examples were plotted with the `plot_examples_nd()` function available -[here](https://github.com/clugen/CluGen.jl/blob/master/docs/CluGenExtras.jl). +[here](https://github.com/clugen/CluGen.jl/blob/main/docs/CluGenExtras.jl). ```@example 82 ENV["GKSwstype"] = "100" # hide diff --git a/docs/src/index.md b/docs/src/index.md index cf60b39..58b3395 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,13 +1,13 @@ # Home -**CluGen.jl** is a Julia package for generating multidimensional clusters. -Each cluster is supported by a line segment, the position, orientation and -length of which guide where the respective points are placed. It provides the -[`clugen()`](@ref) function for this purpose, as well as a number of auxiliary -functions, used internally and modularly by [`clugen()`](@ref). Users can swap -these auxiliary functions by their own customized versions, fine-tuning their -cluster generation strategies, or even use them as the basis for their own -generation algorithms. +**CluGen.jl** is a Julia implementation of the *clugen* algorithm for generating +multidimensional clusters. Each cluster is supported by a line segment, the +position, orientation and length of which guide where the respective points are +placed. It provides the [`clugen()`](@ref) function for this purpose, as well as +a number of auxiliary functions, used internally and modularly by +[`clugen()`](@ref). Users can swap these auxiliary functions by their own +customized versions, fine-tuning their cluster generation strategies, or even +use them as the basis for their own generation algorithms. ## How to install