Skip to content

Commit

Permalink
describe new leap second functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
eteq committed Dec 5, 2019
1 parent 631dc43 commit ba857c9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,24 @@ C macro prefixes
All C macros used in ERFA are the same as their SOFA equivalents, but with an
``ERFA_`` prefix to prevent namespace collisions.

Version information
^^^^^^^^^^^^^^^^^^^

ERFA provides a few utility functions for accessing version information at
runtime which are not a part of SOFA. Specifically, these are the
``eraVersion`,` ``eraVersion*``, and ``eraSofaVersion`` functions that are
exposed in the ``erfaextra.h`` header.

Runtime leap second modification
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ERFA provides the capability to modify at runtime the leap seconds assumed for
various calculations. These are accessed via the ``eraGetLeapSeconds`` and
``eraSetLeapSeconds`` functions that are exposed in the ``erfaextra.h`` header.
This functionality is currently considered somewhat experimental, meaning an
improved API might be available in the future, but the current API can also be
counted on for the near future.

Bugfixes
^^^^^^^^

Expand Down

0 comments on commit ba857c9

Please sign in to comment.