Skip to content

Commit 4f0b02b

Browse files
committed
doc(README.md): reformat/clarify ref descriptions
1 parent 9960f0a commit 4f0b02b

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,18 @@ meson install -C build
6565
```
6666

6767
## Documentation
68-
See [https://fortran-lang.github.io/fftpack/](https://fortran-lang.github.io/fftpack/) for documentation generated by this repository's [FORD] [project file].
68+
See the our [GitHub Pages site] for documentation generated by [FORD] from the fortran-lang/fftpack [project file].
6969

7070
## References
71-
- [Recommended reference]: Although this SciPy version is in Python and the procedures have different arguments from [fortran-lang/fftpack], the SciPy fftpack documentation provides a succinct description of the storage sequence for the function results in both scipy.fftpack and [fortran-lang/fftpack], e.g., the storage sequence for the `rfft` function result.
72-
- [Historical reference]: This is the netlib/fftpack library on which [fortran-lang/fftpack] is based but the two are _not_ interface-compatible.
73-
- [Theory reference]: The documentation for the GNU/gsl FFT routines, which is also based on netlib/fftpack, provides some useful definitions of FFT terminology and represenations of the analytical forms of the Discrete Fourier Transform nicely formatted by [LaTeX].
71+
Although fortran-lang is _not_ interface-compatible with any of the following libraries, each contains documentation that might be useful for different reasons:
72+
- **Recommended reference:** The [scipy.fftpack] documentation contains succinct description of the storage sequences for function results that match those in fortran-lang/fftpack, e.g., the location of the real and imaginary parts of the `rfft` function result.
73+
- **Theory reference:** The [documentation for the GNU/gsl FFT routines], which are also based on netlib/fftpack, provides some useful definitions of FFT terminology and represenations of the analytical forms of the Discrete Fourier Transform nicely formatted by [LaTeX].
74+
- **Historical reference:** The [netlib/fftpack] library on which fortran-lang/fftpack is useful for understanding several fortran-lang/fftpack design choices, e.g., the procedure dependencies.
7475

7576
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford
7677
[project file]: ./API-doc-FORD-file.md
77-
[fortran-lang/fftpack]: https://github.com/fortran-lang/fftpack
78-
[Recommended reference]: https://docs.scipy.org/doc/scipy/reference/fftpack.html
79-
[Historical reference]: http://www.netlib.org/fftpack/
80-
[Theory reference]: https://www.gnu.org/software/gsl/doc/html/fft.html#
78+
[scipy.fftpack]: https://docs.scipy.org/doc/scipy/reference/fftpack.html
79+
[documentation for the GNU/gsl FFT routines]: https://www.gnu.org/software/gsl/doc/html/fft.html#
80+
[netlib/fftpack]: http://www.netlib.org/fftpack/
8181
[LaTeX]: https://www.latex-project.org
82+
[GitHub Pages site]: https://fortran-lang.github.io/fftpack/

0 commit comments

Comments
 (0)