VeOmni / rules

---
description: Do not use decorative section divider comments in Python code
globs: "**/*.py"
alwaysApply: false
---

# No Section Divider Comments

Do NOT add decorative section-divider comments like:

```python
# ---------------------------------------------------------------------------
# Some Section Name
# ---------------------------------------------------------------------------
```

or

```python
# ------------------------------------------------------------------
# Some Section Name
# ------------------------------------------------------------------
```

These add visual noise without value. If code needs grouping, use module-level or class-level docstrings, or simply rely on class/function structure.

## Exception: patchgen patch headers

`veomni/models/transformers/*/**_patch_gen_config.py` and the
`generated/patched_modeling_*.py` files they emit are exempt. There, the

```python
# ================================================================
# Patch: <Class>.<method>
# 1. <what changed> — <why>
# ================================================================
```

headers plus inline `# --- Patch.N ---` markers are a required convention: they
survive into the generated file and are what makes it reviewable against the
upstream HuggingFace source. See `.agents/skills/veomni-patchgen-model/SKILL.md`.

More agent context in ByteDance-Seed/VeOmni

13 other files this repository gives its agents.