Repository navigation
Prepublish updates - #20
Merged
Merged
Conversation
The README pointed at the private repository over SSH. It now installs the published gem, and says that a plain gem install on Ruby 2.7 or 3.0 needs nokolexbor 0.6.4 first: RubyGems picks nokolexbor 0.8, which needs Ruby 3.1, while Bundler resolves to 0.6.4 on its own. Only Nokodown.extract, Nokodown.to_markdown and Nokodown::Result are public; the other classes can change in any release.
Apache-2.0 section 4(d) requires a derivative work to include the attribution notices from its source's NOTICE file. Readability's lists Mozilla and Contributors as well as Arc90, and ours had only Arc90.
nokolexbor is limited to 0.x, so a 1.0 with breaking changes is not picked up, and gem build no longer warns about an open-ended dependency. The gem links its source, changelog and issues on RubyGems, and pushing a release needs MFA. CHANGELOG.md starts with 0.1.0 and ships in the gem.
The README described how to wire the gem into the Extract API and benchmarked the API's current rule by name. The integration notes belong with that change, not in a public README, and the baseline is now named for what it does: convert the page's <main>, else its only <article>, else <body>, without main-content detection. Its scores are unchanged; run_nokodown.rb takes "baseline" instead of "current". Comments that described SerpApi's production Ruby and nokolexbor versions now say why CI tests them.
Some test pages were studied while tuning nokodown, and 139 of the 511 have the same HTML as a development page, so the test scores are not a blind result. The README now says so.
Ruby 4.0 warns that the CGI library is gone; cgi/escape has CGI.unescapeHTML on every Ruby from 2.7. From 3.4 URI::DEFAULT_PARSER is the RFC 3986 parser, whose unescape is obsolete, so the resolver uses the RFC 2396 parser where it exists. Both warnings showed only with -W. The specs pass without warnings on Ruby 2.7, 3.4 and 4.0.
The README opens with the SerpApi logo from the media kit, using the gradient version, which reads on GitHub's light and dark themes. A note under the intro links the Extract API for readers who would rather not fetch pages themselves.
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.
Prepare nokodown for open-sourcing and RubyGems 0.1.0:
nokolexbor ~> 0.6,