Merged
Conversation
simon04
reviewed
Jun 5, 2025
Contributor
simon04
left a comment
simon04
left a comment
There was a problem hiding this comment.
Thank you. Looks good, but please consider a few suggestions for improvement.
| extract_header_text(at_css('h1.chapter').content) | ||
| end | ||
|
|
||
| def additional_entries |
Contributor
There was a problem hiding this comment.
Please also add all (relevant) functions and (math) operators. Searching for zfopen currently yields no result.
lib/docs/filters/zsh/entries.rb
Outdated
| header_text = module_name if module_name.present? | ||
| end | ||
|
|
||
| entries << [header_text, a['name'], type] if header_text != 'Description' |
Contributor
There was a problem hiding this comment.
Some entries lack context, for instance "utility" refers to different topics. Suggestion: add some helpful context in parenthesis after the entry name, such as "Utility functions (calendar)".
Contributor
Author
There was a problem hiding this comment.
Thanks for the suggestion. What is a good example of a previous scraper adding context to ambiguously named entries?
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.
Fixes #2184.
public/icons/your_scraper_name/directory:16.png: a 16×16 pixel icon for the doc16@2x.png: a 32×32 pixel icon for the docSOURCE: A text file containing the URL to the page the image can be found on or the URL of the original image itself