Skip to content

Commit

Permalink
Update Docstrings in SK properties
Browse files Browse the repository at this point in the history
  • Loading branch information
hschnait committed Mar 8, 2022
1 parent c4db7e6 commit 9ae739a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions python/triqs_dft_tools/block_structure.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,13 +136,13 @@ def gf_struct_solver_list(self):
This is returned as a
list (for each shell)
of lists (for each block)
of tuples (block_name, block_indices).
of tuples (block_name, block_dimension).
That is,
``gf_struct_solver_list[ish][b][0]``
is the name of the block number ``b`` of shell ``ish``, and
``gf_struct_solver_list[ish][b][1]``
is a list of its indices.
is the dimension of the block ``b``.
The list for each shell is sorted alphabetically by block name.
"""
Expand All @@ -159,13 +159,13 @@ def gf_struct_sumk_list(self):
This is returned as a
list (for each shell)
of lists (for each block)
of tuples (block_name, block_indices)
of tuples (block_name, block_dimension)
That is,
``gf_struct_sumk_list[ish][b][0]``
is the name of the block number ``b`` of shell ``ish``, and
``gf_struct_sumk_list[ish][b][1]``
is a list of its indices.
is the dimension of the block ``b``.
"""
return self.gf_struct_sumk

Expand All @@ -179,7 +179,7 @@ def gf_struct_solver_dict(self):
That is,
``gf_struct_solver_dict[ish][bname]``
is a list of the indices of block ``bname`` of shell ``ish``.
is the dimension of block ``bname`` of shell ``ish``.
"""
return self.gf_struct_solver

Expand All @@ -193,7 +193,7 @@ def gf_struct_sumk_dict(self):
That is,
``gf_struct_sumk_dict[ish][bname]``
is a list of the indices of block ``bname`` of shell ``ish``.
is the dimension of block ``bname`` of shell ``ish``.
"""
if self.gf_struct_sumk is None:
return None
Expand Down

0 comments on commit 9ae739a

Please sign in to comment.