Skip to content

chore(sdk-python): prefix ADR numbers with PY- for global uniqueness - #6

Merged
Raphjacksun7 merged 3 commits into
mainfrom
chore/wave2-adr-prefix
Jun 10, 2026
Merged

Raphjacksun7 merged 3 commits into
mainfrom
chore/wave2-adr-prefix

Conversation

@Raphjacksun7

Copy link
Copy Markdown
Contributor

Summary

  • Prefix all ADR filenames in docs/adr/ with PY- for global uniqueness across the PocketStation mono-repo
  • Update all in-file cross-references and source code comments that cited bare ADR-NNN numbers

Files renamed

10 ADR files: PY-004 through PY-023 (varies)

Changes

  • All docs/adr/ADR-NNN-*.md renamed to PY-NNN-*.md using git mv
  • Internal ADR cross-references updated via sed
  • Source code references updated in relevant source and .md files outside docs/adr/

Testing

  • Verified: git ls-files docs/adr/ | grep "^docs/adr/ADR-[0-9]" returns 0 results
  • Verified: git ls-files docs/adr/ | grep "^docs/adr/PY-" returns 10 results
  • No functional code changes — rename and cross-reference update only

Breaking Changes

None. Internal documentation reorganization only.

Raphael Avocegamou added 3 commits June 8, 2026 17:30
…tighten gitignore

station.py:
- Extract URL/duration magic values into named module constants
- Add PocketStation.create() classmethod for one-call room+connect setup
- Replace bare r.raise_for_status() with typed PocketStationError raises
  (network_error, http_error, parse_error codes) for structured handling
- Rename stop() to close() — Pythonic async resource convention
- Remove misleading "Falls back gracefully" docstring from listen()

__init__.py:
- Reorder imports: PocketStation (primary class) before PocketStationClient

gitignore: add Python artifact patterns (__pycache__, .egg-info, .pytest_cache, venv)

All 15 tests pass.
Renamed all docs/adr/ADR-NNN-*.md files to PY-NNN-*.md.
Updated all in-file cross-references within ADR docs.
Updated all source code references in .go/.rs/.swift/.ts/.kt/.py/.md files.
@Raphjacksun7
Raphjacksun7 merged commit 9353c02 into main Jun 10, 2026
6 checks passed
@Raphjacksun7
Raphjacksun7 deleted the chore/wave2-adr-prefix branch June 10, 2026 00:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant