Skip to content

Commit 6b2458a

Browse files
committed
update docs
1 parent 3fbab21 commit 6b2458a

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

docs/api.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# API Reference
22

3-
::: w90io.parse_win
4-
::: w90io.parse_nnkp
3+
::: w90io.parse_win_raw
4+
::: w90io.parse_nnkp_raw
5+
::: w90io.parse_wout_iteration_info
56
::: w90io.read_amn
7+
::: w90io.write_amn
68
::: w90io.read_eig
9+
::: w90io.write_eig

src/w90io/_wout.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,16 @@
4545

4646

4747
def parse_wout_iteration_info(stream: typing.TextIO) -> dict:
48+
"""
49+
Parse WOUT iteration info
50+
51+
Arguments:
52+
stream: a file-like stream
53+
54+
Returns:
55+
the parsed WOUT iteration info
56+
57+
"""
4858
convergence = []
4959
spread = []
5060
delta = []

0 commit comments

Comments
 (0)