Skip to content

Commit 9b66077

Browse files
authored
Add a warning explaining that the api docs are duplicated [ci skip] (#302)
1 parent b5da322 commit 9b66077

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

doc/module-components.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
Module Components
22
=================
33

4+
.. warning::
5+
6+
This page is converted from the original :math:`\LaTeX` documentation, but
7+
may no longer reflect the current state of the library. See the API docs at
8+
:doc:`api` for more up-to-date but less structured and in-depth descriptions.
9+
10+
If you would like to help with merging the descriptions on the API with a
11+
description on this page, please head over to :issue:`300` on GitHub, where
12+
there's an explanation of how to do so. Even merging just one function
13+
explanation helps!
14+
15+
Any function or class below with a ``[source]`` link to its right is
16+
guaranteed to be up-to-date already, as its documentation is identical on
17+
both pages.
18+
419
The geometric algebra module consists of the following files and classes
520

621
+----------------+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

galgebra/__init__.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""
1+
r"""
22
.. currentmodule:: galgebra
33
========================================
44
galgebra (:mod:`galgebra`)
@@ -19,6 +19,17 @@
1919
dop
2020
printer
2121
utils
22+
23+
.. note::
24+
25+
Some functions may be better documented by the original non-generated docs
26+
on the :doc:`module-components` page, but there is a risk the descriptions
27+
there are outdated.
28+
29+
If you would like to help with merging the descriptions here with a
30+
description on that page, please head over to :issue:`300` on GitHub, where
31+
there's an explanation of how to do so. Even merging just one function
32+
explanation helps!
2233
"""
2334

2435
from ._version import __version__ # noqa: F401

0 commit comments

Comments
 (0)