Skip to content

Clarify interface #33

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

Merged
janbridley merged 12 commits into from
Jan 18, 2025
Merged

Clarify interface #33

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7f85d28
Standardize cif example in parsnip module
janbridley Jan 18, 2025
71a1da6
Rename table_labels to loop_labels
janbridley Jan 18, 2025
3a6962a
Move parameterless read methods to properties
janbridley Jan 18, 2025
5f5d730
Generalize getitem
janbridley Jan 18, 2025
c9fd5a6
Clarify tip for getitem
janbridley Jan 18, 2025
2cff3a9
Lint parsnip.py
janbridley Jan 18, 2025
e7f2420
Add pathlib to type hints
janbridley Jan 18, 2025
be498c7
Move loop_labels
janbridley Jan 18, 2025
7883232
Move getitem to front
janbridley Jan 18, 2025
5b4c9f2
Move pairs before loops
janbridley Jan 18, 2025
5275ac1
Expand on docs
janbridley Jan 18, 2025
e185e7e
Additional test for getitem
janbridley Jan 18, 2025
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
Prev Previous commit
Next Next commit
Clarify tip for getitem
  • Loading branch information
@janbridley
janbridley committed Jan 18, 2025
commit c9fd5a6c2c591af2185e5b1ddd1266bae3cd1a65
5 changes: 3 additions & 2 deletions parsnip/parsnip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,8 +295,9 @@ def __getitem__(self, index: str | Iterable[str]):

.. tip::

This method of accessing data is recommended for most uses, as it best
ensures data is returned where possible.
This method of accessing data is recommended for most uses, as it ensures
data is returned wherever possible. :meth:`~.get_from_loops` may be useful
when multi-column slices of an array are needed.

Example
-------
Expand Down