Skip to content

Commit

Permalink
Small improvements to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nunofachada committed Jan 22, 2023
1 parent c074322 commit 62fd648
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
10 changes: 5 additions & 5 deletions docs/src/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

2 comments on commit 62fd648

@nunofachada
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/76146

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 62fd64817a66d4ae506fa1dc7b633b69735dbc2c
git push origin v0.1.0

Please sign in to comment.