Skip to content

fix(doc): Fix titles and minor corrections #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fraya merged 1 commit into from
May 31, 2026
Merged

fix(doc): Fix titles and minor corrections #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions doc/source/gsl-common.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. current-library:: dylan-gsl

The GSL-COMMON module
*********************
GSL-COMMON
**********

.. current-library:: dylan-gsl
.. current-module:: gsl-common


Expand All @@ -23,4 +22,4 @@ The GSL-COMMON module

.. macro:: with-c-double-array

.. macro:: with-gsl-check-success
.. macro:: with-gsl-check-success
4 changes: 2 additions & 2 deletions doc/source/gsl-error.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-ERROR module
********************
GSL-ERROR
*********

.. current-library:: dylan-gsl
.. current-module:: gsl-error
Expand Down
7 changes: 4 additions & 3 deletions doc/source/gsl-ffi-block.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
The GSL-FFI-BLOCK module
*****************************
GSL-FFI-BLOCK
*************

.. current-library:: dylan-gsl
.. current-module:: gsl-ffi-block

Expand Down Expand Up @@ -39,4 +40,4 @@ Allocation functions

:signature: gsl-block-free (block) => ()

:parameter block: An instance of `<gsl-block*>`.
:parameter block: An instance of `<gsl-block*>`.
5 changes: 3 additions & 2 deletions doc/source/gsl-ffi-complex.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
The GSL-FFI-COMPLEX module
**************************
GSL-FFI-COMPLEX
***************

.. current-library:: dylan-gsl
.. current-module:: gsl-ffi-complex

Expand Down
6 changes: 3 additions & 3 deletions doc/source/gsl-ffi-error.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-FFI-ERROR module
************************
GSL-FFI-ERROR
*************

.. current-library:: dylan-gsl
.. current-module:: gsl-ffi-error
Expand Down Expand Up @@ -83,4 +83,4 @@ Error functions
:signature: gsl-strerror (status) => (message)

:parameter status: An instance of :class:`<c-int>`.
:value message: An instance of :class:`<c-string>`.
:value message: An instance of :class:`<c-string>`.
6 changes: 3 additions & 3 deletions doc/source/gsl-ffi-math.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-FFI-MATH module
***********************
GSL-FFI-MATH
************

.. current-library:: dylan-gsl
.. current-module:: gsl-ffi-math
Expand Down Expand Up @@ -154,4 +154,4 @@ Elementary functions

:parameter x: An instance of ``export-type-for(<c-double>)``.
:parameter n: An instance of ``export-type-for(<c-int>)``.
:value frexp-xn: An instance of ``import-type-for(<c-double>)``.
:value frexp-xn: An instance of ``import-type-for(<c-double>)``.
4 changes: 2 additions & 2 deletions doc/source/gsl-ffi-rng.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-FFI-RNG module
**********************
GSL-FFI-RNG
***********

.. current-library:: dylan-gsl
.. current-module:: gsl-ffi-rng
Expand Down
4 changes: 2 additions & 2 deletions doc/source/gsl-ffi-running-statistics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-FFI-RUNNING-STATISTICS module
*************************************
GSL-FFI-RUNNING-STATISTICS
**************************

.. current-library:: dylan-gsl
.. current-module:: gsl-ffi-running-statistics
Expand Down
7 changes: 4 additions & 3 deletions doc/source/gsl-ffi-statistics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
The GSL-FFI-STATISTICS module
*****************************
GSL-FFI-STATISTICS
******************

.. current-library:: dylan-gsl
.. current-module:: gsl-ffi-statistics

Expand Down Expand Up @@ -591,4 +592,4 @@ Robust Scale Estimates
:parameter n: An instance of `<c-size-t>`.
:parameter work: An instance of `<c-double*>`.
:parameter work-int: An instance of `<c-int*>`.
:value qn: An instance of `<c-double>`.
:value qn: An instance of `<c-double>`.
4 changes: 2 additions & 2 deletions doc/source/gsl-ffi-vector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-FFI-VECTOR module
*************************
GSL-FFI-VECTOR
**************

.. current-library:: dylan-gsl
.. current-module:: gsl-ffi-vector
Expand Down
6 changes: 3 additions & 3 deletions doc/source/gsl-math.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-MATH module
*******************
GSL-MATH
********

.. current-library:: dylan-gsl
.. current-module:: gsl-math
Expand Down Expand Up @@ -138,4 +138,4 @@ Elementary functions

:parameter x: An instance of :drm:`<double-float>`.
:value mantissa: An instance of :drm:`<double-float>`.
:value exponent: An instance of :drm:`<integer>`.
:value exponent: An instance of :drm:`<integer>`.
5 changes: 3 additions & 2 deletions doc/source/gsl-rng.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-RNG module
**********************
GSL-RNG
*******

.. current-library:: dylan-gsl
.. current-module:: gsl-rng
Expand Down Expand Up @@ -56,6 +56,7 @@ Random number environment variables

.. code-block:: shell

$ test-rng.exe
generator type: mt19937
seed = 0
first value = 4293858116
Expand Down
6 changes: 3 additions & 3 deletions doc/source/gsl-running-statistics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-RUNNING-STATISTICS module
*********************************
GSL-RUNNING-STATISTICS
**********************

.. current-library:: dylan-gsl
.. current-module:: gsl-running-statistics
Expand Down Expand Up @@ -156,4 +156,4 @@ Quantiles

:signature: quantile-rstat-reset! (quantile-rstat) => ()

:parameter quantile-rstat: An instance of :class:`<quantile-rstat>`.
:parameter quantile-rstat: An instance of :class:`<quantile-rstat>`.
6 changes: 3 additions & 3 deletions doc/source/gsl-statistics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-STATISTICS module
*************************
GSL-STATISTICS
**************

.. current-library:: dylan-gsl
.. current-module:: gsl-statistics
Expand Down Expand Up @@ -361,4 +361,4 @@ Robust Scale Estimates
:signature: qn (sorted-data) => (qn)

:parameter data: An instance of :class:`<gsl-vector>`.
:value qn: An instance of :drm:`<double-float>`.
:value qn: An instance of :drm:`<double-float>`.
6 changes: 3 additions & 3 deletions doc/source/gsl-vector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The GSL-VECTOR module
*************************
GSL-VECTOR
**********

.. current-library:: dylan-gsl
.. current-module:: gsl-vector
Expand Down Expand Up @@ -682,4 +682,4 @@ Vector properties

let a = make(<gsl-vector>, size: 10, fill: 1.0d0);
let b = make(<gsl-vector>, size: 10, fill: 1.0d0);
f=(a, b, epsilon: 0.00001d0);
f=(a, b, epsilon: 0.00001d0);
6 changes: 0 additions & 6 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
The DYLAN-GSL library
=======================

GSL modules
***********

.. toctree::
:maxdepth: 2
:caption: GSL modules:
Expand All @@ -17,9 +14,6 @@ GSL modules
gsl-running-statistics
gsl-rng

FFI modules
***********

.. toctree::
:maxdepth: 2
:caption: FFI modules:
Expand Down