Skip to content

Restored lattice-names doc #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JeanLucPons wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −1
Open

Restored lattice-names doc #410

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ce1b53
Restored lattice-names doc
JeanLucPons Sep 14, 2026
111ccb9
Removed duplicated line
JeanLucPons Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion pyaml/common/element.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,16 @@ class Element:
Unique element name.
lattice_names : str or None, optional
Lattice element selector associated with this element. Defaults to
``name`` when omitted.
``name`` when omitted. A pyAML element can be associated to several lattice elements.

| Supported syntax of lattice_names:
| ``list(name,[name])`` : Lattice element names
| ``[name]@idx[,idx]`` : Lattice element indices in the subset formed by name.
| ``[name]#start_idx..end_idx`` : Lattice element range in the subset formed by name.

In the above syntax, if the name is not specficied, the whole set
of lattice element is used for indexing.

description : str or None, optional
Human-readable element description.

Expand Down
Loading