Skip to content

Commit

Permalink
md: Explain that API docs are generated from code
Browse files Browse the repository at this point in the history
  • Loading branch information
real-or-random committed Jul 4, 2024
1 parent 84474c4 commit d603e6f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -420,8 +420,7 @@ and callers can simply use the recovery functionality instead.
The purpose of this section is to provide a high-level overview of the interface and usage of ChillDKG,
aimed at developers who would like to use a ChillDKG implementation in their applications and systems.
Detailed interface documentation of the implementation is also provided in form of Python docstrings in the reference implementation
(see [`python/chilldkg_ref/chilldkg.py`](python/chilldkg_ref/chilldkg.py).)
Detailed API documentation of the reference implementation is provided in [Subsection "API Documentation"](#api-documentation).
Developers who would like to implement ChillDKG or understand ChillDKG's internals and reference implementation,
should also read [Section "Internals of ChillDKG"](#internals-of-chilldkg).
Expand Down Expand Up @@ -518,7 +517,8 @@ TODO Write
### API Documentation
TODO Write
This subsection is an export of the API documentation generated from the docstrings in the reference implementation
(see [`python/chilldkg_ref/chilldkg.py`](python/chilldkg_ref/chilldkg.py).)
<!--pydoc.md-->
#### hostpubkey
Expand Down

0 comments on commit d603e6f

Please sign in to comment.