Skip to content

Commit 1083d83

Browse files
authored
Update doc links, tweak docs (#14)
For the transfer to HolyLab
1 parent 06ded14 commit 1083d83

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# ThickNumbers
22

3-
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://timholy.github.io/ThickNumbers.jl/dev/)
4-
[![Build Status](https://github.com/timholy/ThickNumbers.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/timholy/ThickNumbers.jl/actions/workflows/CI.yml?query=branch%3Amain)
5-
[![Coverage](https://codecov.io/gh/timholy/ThickNumbers.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/timholy/ThickNumbers.jl)
3+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://HolyLab.github.io/ThickNumbers.jl/dev/)
4+
[![Build Status](https://github.com/HolyLab/ThickNumbers.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/HolyLab/ThickNumbers.jl/actions/workflows/CI.yml?query=branch%3Amain)
5+
[![Coverage](https://codecov.io/gh/HolyLab/ThickNumbers.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/HolyLab/ThickNumbers.jl)
66

7-
This package defines a new abstract type, `ThickNumber{T}`, which is like Julia's `Number` but represents numbers that may have a "thickness" or "width". Such numbers generally support arithmetic but also act like sets, in the sense that they contain spans of "point" numbers. Prominent examples of such numbers include [intervals](https://en.wikipedia.org/wiki/Interval_arithmetic) and [gaussian random variables](https://en.wikipedia.org/wiki/Algebra_of_random_variables).
7+
This package defines a new abstract type, `ThickNumber{T}`, which is like Julia's `Number` but represents numbers that may have a "thickness" or "width". Such numbers generally support arithmetic but also act like sets, in the sense that they contain spans of "point" numbers. Prominent examples of such numbers include [intervals](https://en.wikipedia.org/wiki/Interval_arithmetic) and [Gaussian random variables](https://en.wikipedia.org/wiki/Algebra_of_random_variables).
88

9-
It also defines a common API for working with ThickNumber types, making it possible to write code that supports multiple `ThickNumber` subtypes simultaneously. See the [documentation](https://timholy.github.io/ThickNumbers.jl/dev/) for details.
9+
It also defines a common API for working with ThickNumber types, making it possible to write code that supports multiple `ThickNumber` subtypes simultaneously. See the [documentation](https://HolyLab.github.io/ThickNumbers.jl/dev/) for details.

docs/make.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ DocMeta.setdocmeta!(ThickNumbers, :DocTestSetup, :(using ThickNumbers); recursiv
66
makedocs(;
77
modules=[ThickNumbers],
88
authors="Tim Holy <tim.holy@gmail.com> and contributors",
9-
repo="https://github.com/timholy/ThickNumbers.jl/blob/{commit}{path}#{line}",
9+
repo="https://github.com/HolyLab/ThickNumbers.jl/blob/{commit}{path}#{line}",
1010
sitename="ThickNumbers.jl",
1111
format=Documenter.HTML(;
1212
prettyurls=get(ENV, "CI", "false") == "true",
13-
canonical="https://timholy.github.io/ThickNumbers.jl",
14-
repolink="https://github.com/timholy/ThickNumbers.jl",
13+
canonical="https://HolyLab.github.io/ThickNumbers.jl",
14+
repolink="https://github.com/HolyLab/ThickNumbers.jl",
1515
edit_link="main",
1616
assets=String[],
1717
),
@@ -25,7 +25,7 @@ makedocs(;
2525
)
2626

2727
deploydocs(;
28-
repo="github.com/timholy/ThickNumbers.jl",
28+
repo="github.com/HolyLab/ThickNumbers.jl",
2929
devbranch="main",
3030
push_preview=false, # see also the corresponding flag in .github/workflows/CleanPreview.yml
3131
)

docs/src/developers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ If possible, you should also define:
3333
If you cannot define this for your type (e.g., `MyType` requires more than two arguments to construct), it is likely that you'll have to specialize some of the [User API](@ref) functions for `MyType`, since the default implementations of some of them rely on `lohi`.
3434

3535
There are also numerous optional methods you can specialize if it makes `MyType` operate more
36-
efficiently. For example, a gaussian random variable package might want to implement [`midrad(MyType{T}, center, σ)`](@ref) to construct values directly, assuming this is the natural parametrization
36+
efficiently. For example, a Gaussian random variable package might want to implement [`midrad(MyType{T}, center, σ)`](@ref) to construct values directly, assuming this is the natural parametrization
3737
of this type.
3838

3939
## Ensuring compliance with the ThickNumbers interface

docs/src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ CurrentModule = ThickNumbers
55
# ThickNumbers
66

77
A `ThickNumber{T}` is an abstract type denoting objects that act like numbers--they have standard algebraic operations `+`, `-`, `*`, and `/`--but also
8-
have properties of a [connected set](https://en.wikipedia.org/wiki/Connected_space), specifically occupying some "width," e.g., a segment of the real number line. Examples of possible concrete subtypes include [intervals](https://en.wikipedia.org/wiki/Interval_arithmetic), [gaussian random variables](https://en.wikipedia.org/wiki/Algebra_of_random_variables), and potentially others. While the parameter `T` in `ThickNumber` does not necessarily have to be `T<:Real`, it should have an ordering so that "width" has some meaning.
8+
have properties of a [connected set](https://en.wikipedia.org/wiki/Connected_space), specifically occupying some "width," e.g., a segment of the real number line. Examples of possible concrete subtypes include [intervals](https://en.wikipedia.org/wiki/Interval_arithmetic), [Gaussian random variables](https://en.wikipedia.org/wiki/Algebra_of_random_variables), and potentially others. While the parameter `T` in `ThickNumber` does not necessarily have to be `T<:Real`, it should have an ordering so that "width" has some meaning.
99

1010
This documentation is aimed at:
1111

@@ -47,7 +47,7 @@ Let `x` and `y` refer to a standard "point" numbers and `X` and `Y` correspondin
4747

4848
With only a few exceptions, the names of these come from the Interval Arithmetic Standard (IEEE Std 1788-2015).
4949

50-
- [`loval(X)`](@ref): return the "lower bound" (which may not be "fuzzy" for some ThickNumber subtypes) of `X` (similar to `inf` in the IEEE standard, but without promising the true infimum)
50+
- [`loval(X)`](@ref): return the "lower bound" of `X` (similar to `inf` in the IEEE standard, but without promising the true infimum: this is directed at types like Gaussian random variables which, strictly speaking, all have a infimum of -∞ but for which the bulk of the distribution has finite lower bound)
5151
- [`hival(X)`](@ref): return the "upper bound" of `X` (similar to `sup` in the IEEE standard)
5252
- [`mid(X)`](@ref): return the midpoint of `X`
5353
- [`wid(X)`](@ref): return the width (`hival - loval`) of `X`

docs/src/user_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ valuetype
1313

1414
## Query functions
1515

16-
API functions from the Interval Arithmetic Standard (IEEE Std 1788-2015), Table 9.2 are supported. One (deliberate) exception is `inf` and `sup`, which are replaced by [`loval`](@ref) and [`hival`](@ref): `inf` and `sup` have well-defined mathematical meanings that may not be appropriate for all `ThickNumber` subtypes (e.g., gaussian random variables don't have finite lower and upper bounds). If you are creating an interval arithmetic package, of course you can choose to define
16+
API functions from the Interval Arithmetic Standard (IEEE Std 1788-2015), Table 9.2 are supported. One (deliberate) exception is `inf` and `sup`, which are replaced by [`loval`](@ref) and [`hival`](@ref): `inf` and `sup` have well-defined mathematical meanings that may not be appropriate for all `ThickNumber` subtypes (e.g., Gaussian random variables don't have finite lower and upper bounds). If you are creating an interval arithmetic package, of course you can choose to define
1717

1818
```
1919
inf(x::MyInterval) = loval(x)

0 commit comments

Comments
 (0)