Skip to content

Commit 42238b1

Browse files
committed
doc: amended stuff and fixed hcp
Signed-off-by: Nick Papior <[email protected]>
1 parent 0f29d09 commit 42238b1

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

sisl/geom/basic.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,12 @@ def hcp(a, atom, coa=1.63333, orthogonal=False):
9797
9898
Parameters
9999
----------
100-
alat : float
101-
lattice parameter
100+
a : float
101+
lattice parameter for 1st and 2nd lattice vectors
102102
atom : Atom
103103
the atom in the HCP lattice
104+
coa : float, optional
105+
c over a parameter where c is the 3rd lattice vector length
104106
orthogonal : bool, optional
105107
whether the lattice is orthogonal (4 atoms)
106108
"""

sisl/geom/bilayer.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ def bilayer(bond=1.42, bottom_atom=None, top_atom=None, stacking='AB',
3535
layer : {'both', 'bottom', 'top'}
3636
control which layer(s) to return
3737
38+
See Also
39+
--------
40+
honeycomb: honeycomb lattices
41+
graphene: graphene geometry
42+
3843
References
3944
----------
4045
.. [1] G. Trambly de Laissardiere, D. Mayou, L. Magaud, "Localization of Dirac Electrons in Rotated Graphene Bilayers", Nano Letts. 10, 804-808 (2010)

sisl/geom/flat.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ def honeycomb(bond, atom, orthogonal=False):
2222
See Also
2323
--------
2424
graphene: the equivalent of this, but with default of Carbon atoms
25+
bilayer: create bilayer honeycomb lattices
2526
"""
2627
sq3h = 3.**.5 * 0.5
2728
if orthogonal:
@@ -59,6 +60,7 @@ def graphene(bond=1.42, atom=None, orthogonal=False):
5960
See Also
6061
--------
6162
honeycomb: the equivalent of this, but with non-default atoms
63+
bilayer: create bilayer honeycomb lattices
6264
"""
6365
if atom is None:
6466
return honeycomb(bond, Atom(Z=6, R=bond * 1.01), orthogonal)

0 commit comments

Comments
 (0)