fix(hackernews): docs say num_comments, matching the emitted key (#106) - #110
Merged
Conversation
The scraper emits the comment count under 'num_comments' (the Algolia HN field name), but the sync docstring, the MCP tool description, and its usage hint all called the field 'comments'. Anyone reading the docs would look for a key that isn't there. Align the three doc sites to the real key. Left the 'comment' tags filter value alone (that one is correct). Added assertions to the HN parse test that lock the key to 'num_comments' and that 'comments' is absent.
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
2 participants
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.
The scraper emits the comment count under 'num_comments' (the Algolia HN field name), but the sync docstring, the MCP tool description, and its usage hint all called the field 'comments'. Anyone reading the docs would look for a key that isn't there.
Align the three doc sites to the real key. Left the 'comment' tags filter value alone (that one is correct). Added assertions to the HN parse test that lock the key to 'num_comments' and that 'comments' is absent.
Closes #106