Skip to content

docs: clarify ingestion docstrings - #131

Merged
Paul-Kyle merged 1 commit into
phasespace-labs:mainfrom
Tethys0:docs/clarify-ingestion-docstrings-130
Aug 15, 2026
Merged

docs: clarify ingestion docstrings#131
Paul-Kyle merged 1 commit into
phasespace-labs:mainfrom
Tethys0:docs/clarify-ingestion-docstrings-130

Conversation

@Tethys0

@Tethys0 Tethys0 commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

Why

The generated prose in the ingest_url and write_research_file docstrings does not describe the existing API, including a return description that suggests a payload pipeline rather than a file path. This resolves #130.

What changed

Replaced only the five requested url, name, content, source_url, and return descriptions with plain descriptions derived from the current function bodies. No runtime behavior changed.

Verification

  • python -m pytest tests/test_timestamp_consistency.py -q - 6 passed
  • ruff check palinode/ tests/ scripts/
  • bandit -r palinode/ -ll - no medium/high findings
  • git diff --check
  • independent spec and quality/security review - approved

I also ran the full suite. It is blocked in this local environment by the absent system jq binary: hook tests explicitly execute with PATH limited to /usr/bin:/bin; a baseline run of test_hook_script_counts_user_messages_correctly fails unchanged for that reason. The scoped ingestion test and all requested static checks pass.

Replace generated filler in the URL ingestion and research-file docstrings with descriptions of the existing parameters and return value.
@Paul-Kyle

Copy link
Copy Markdown
Member

Merging — clean, accurate, and exactly the scope. "Optional URL from which the research content was
fetched" is what that parameter always was; the text it replaces claimed a payload pipeline.

GitHub didn't record you as assignee, so the field shows me as tracker proxy — a platform limitation,
not a comment on whose work this is. It's yours and the merged commit carries your authorship. Thanks
for the quick turn, and for the second contribution.

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.

Docstrings in ingest/pipeline.py describe nothing — generated filler text

2 participants