Fix code examples syntax highlighting in YARD documentation #4
Conversation
This file contains 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
Co-authored-by: Thomas Hurst <thomas@serpapi.com>
Freaky
approved these changes
Dec 27, 2023
| @@ -420,12 +465,12 @@ The class SerpApi::Client (client side / ruby): | |||
| Et voila! | |||
|
|
|||
| ## Continuous integration | |||
| We love "true open source" and "continuous integration", and Test Drive Development (TDD). | |||
| We are using RSpec to test [our infrastructure around the clock]) using Github Action to achieve the best QoS (Quality Of Service). | |||
| We love "true open source" and "continuous integration", and Test Drive Development (TDD). We are using RSpec to test our infrastructure around the clock using Github Action to achieve the best QoS (Quality Of Service). | |||
There was a problem hiding this comment.
This weird sentence needs more work I think. What's it even trying to say? What is "true" open source and why do it and CI need scare quotes? Is name-dropping more abbreviations better for SEO?
Suggested change
| We love "true open source" and "continuous integration", and Test Drive Development (TDD). We are using RSpec to test our infrastructure around the clock using Github Action to achieve the best QoS (Quality Of Service). | |
| We love [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) (CI) and [Test-Driven Development](https://en.wikipedia.org/wiki/Test-driven_development) (TDD) at SerpApi. We use RSpec and Github Actions to test our infrastructure around the clock, and that includes all changes to our clients. |
Comment on lines
+186
to
+187
| async_search = client.search search | ||
| async_search |
There was a problem hiding this comment.
I suppose the intention is to help the user follow information flow by giving it a name? I think it just makes it look cluttered - experienced Ruby devs will think it's silly and inexperienced ones may be confused why there's a variable here that appears to do nothing.
Suggested change
| async_search = client.search search | |
| async_search | |
| client.search search |
Comment on lines
+193
to
+194
| results = client.search_archive search[:id] | ||
| results |
There was a problem hiding this comment.
Suggested change
| results = client.search_archive search[:id] | |
| results | |
| client.search_archive search[:id] |
Comment on lines
+189
to
+191
| # Get an ETA using the last search scheduled time | ||
| bulk_search_eta = async_search_results.last[:search_metadata][:scheduled_at] | ||
| # After the searches are done processing (i.e., `bulk_search_eta`) |
There was a problem hiding this comment.
We probably want to make it clearer there should be a sleep here.
Comment on lines
+184
to
+185
| # Submit async searches | ||
| async_searches = searches.map do |search| |
There was a problem hiding this comment.
Probably want to avoid confusing the user about async vs scheduled by being more consistent in naming?
Suggested change
| # Submit async searches | |
| async_searches = searches.map do |search| | |
| # Submit scheduled searches | |
| scheduled_searches = searches.map do |search| |
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.
We with @Freaky updated the tests to make sure it pass and fixed the syntax highlighting for YARD.