docs: clarify ingestion docstrings - #131
Merged
Paul-Kyle merged 1 commit intoAug 15, 2026
Merged
Conversation
Replace generated filler in the URL ingestion and research-file docstrings with descriptions of the existing parameters and return value.
Member
|
Merging — clean, accurate, and exactly the scope. "Optional URL from which the research content was GitHub didn't record you as assignee, so the field shows me as tracker proxy — a platform limitation, |
This was referenced Aug 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The generated prose in the
ingest_urlandwrite_research_filedocstrings 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 passedruff check palinode/ tests/ scripts/bandit -r palinode/ -ll- no medium/high findingsgit diff --checkI also ran the full suite. It is blocked in this local environment by the absent system
jqbinary: hook tests explicitly execute withPATHlimited to/usr/bin:/bin; a baseline run oftest_hook_script_counts_user_messages_correctlyfails unchanged for that reason. The scoped ingestion test and all requested static checks pass.