Skip to content

Commit 0148816

Browse files
committed
doc: maintained documentation for BandStructure
Signed-off-by: Nick Papior <[email protected]>
1 parent ffb6b01 commit 0148816

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

sisl/physics/brillouinzone.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1576,13 +1576,13 @@ def lineark(self, ticks=False):
15761576
ticks : bool, optional
15771577
if `True` the ticks for the points are also returned
15781578
1579-
lk, xticks, label_ticks, lk = BandStructure.lineark(True)
1579+
lk, ticks, ticklabels = BandStructure.lineark(True)
15801580
15811581
Returns
15821582
-------
15831583
linear_k : The positions in reciprocal space determined by the distance between points
1584-
k_tick : Linear k-positions of the points, only returned if `ticks` is ``True``
1585-
k_label : Labels at `k_tick`, only returned if `ticks` is ``True``
1584+
ticks : Linear k-positions of the points, only returned if `ticks` is ``True``
1585+
ticklabels : Labels at `k_tick`, only returned if `ticks` is ``True``
15861586
"""
15871587
# Calculate points
15881588
k = [self.tocartesian(pnt) for pnt in self.point]

0 commit comments

Comments
 (0)