Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
echo "$GITHUB_WORKSPACE/.venv/bin" >> $GITHUB_PATH

- name: Install dependencies
run: uv pip install -e ".[docs]"
run: uv pip install ".[docs]"

- name: Build documentation with Sphinx
run: |
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ coverage.xml
*.py,cover
.hypothesis/
.pytest_cache/
.ruff_cache/
cover/


Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
uv venv .venv && source .venv/bin/activate
uv pip install -e ".[dev,test,docs,examples]"
git submodule update --init --recursive # fetch test data
pytest tests/ --cov
unittest tests/ --cov
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important: unittest tests/ --cov is not valid syntax. unittest is not a standalone CLI command, and it does not accept --cov. This was previously pytest tests/ --cov (the correct command) and was regressed in this PR.

Suggested change
unittest tests/ --cov
pytest tests/ --cov

```

## Package Structure
Expand Down
14 changes: 5 additions & 9 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
```{meta}
---
description: Complete user guide for Python HEDTools - validation, BIDS
integration, analysis, and command-line tools for HED annotations
keywords: HED tutorial, Python guide, validation examples, BIDS datasets,
sidecar files, command-line interface, Jupyter notebooks, HED overview, event
descriptors, neuroscience, schema
html_meta:
description: Complete user guide for Python HEDTools - validation, BIDS integration, analysis, and command-line tools for HED annotations
keywords: HED tutorial, Python guide, validation examples, BIDS datasets, sidecar files, command-line interface, Jupyter notebooks, HED overview, event descriptors, neuroscience, schema
---
```

# Python HEDTools guide

```{index} user guide, tutorial, getting started, HED, Hierarchical Event Descriptors
```

# Python HEDTools guide

HED (Hierarchical Event Descriptors) is a framework for systematically describing events and experimental metadata in machine-actionable form. This guide provides comprehensive documentation for using the HED Python tools for validation, BIDS integration, and analysis.

## Installation
Expand Down