Skip to content

Commit 03f85da

Browse files
committed
More doc cleanup
1 parent 381d9c6 commit 03f85da

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _api_reference:
22

3-
AID API Reference
4-
=================
3+
AID API
4+
=======
55

66
.. automodapi:: astro_image_display_api.interface_definition
77
:no-inheritance-diagram:

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ How to implement this API in your package
2828
step explains how to assert that your package implements the API correctly.
2929
2. :ref:`testing_AIDA_implementation` describes how to test your
3030
package against the API.
31-
3. There is a :ref:`reference_implementation` of the API that you can use as a
31+
3. There is a :ref:`sample implementation <reference_implementation>` of the API that you can use as a
3232
starting point for your own package. This reference implementation does not
3333
do any image display itself, but provides a set of methods that you can
3434
override to implement your own image display logic on top of the management
@@ -41,6 +41,6 @@ How to implement this API in your package
4141
:hidden:
4242

4343
api.rst
44-
reference_implementation.rst
4544
testing_implementation.rst
45+
reference_implementation.rst
4646
aida_backends.rst

docs/reference_implementation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _reference_implementation:
22

3-
Reference implementation of AIDA non-display logic
4-
==================================================
3+
Sample implementation
4+
=====================
55

66
The class `astro_image_display_api.image_viewer_logic.ImageViewerLogic` is provided
77
as an *example* of how to implement the non-display logic of the Astronomical Image Display API (AIDA).

docs/testing_implementation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _testing_AIDA_implementation:
22

3-
Testing your implementation of AIDA
4-
===================================
3+
Testing
4+
=======
55

66
Our goal is to make it easy for you to test your implementation of the
77
Astronomical Image Display API (AIDA). There are two things you need to test:

0 commit comments

Comments
 (0)