Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix redis examples #5482

Merged
merged 2 commits into from
Sep 12, 2024
Merged

Fix redis examples #5482

merged 2 commits into from
Sep 12, 2024

Conversation

kellen
Copy link
Contributor

@kellen kellen commented Sep 11, 2024

Adds missing Example: prefix needed to make redis example show up on the examples page, fixes usage formatting, moves documentation example into markdown to avoid it rendering as a header, removes scio-private parDo usage

Copy link

codecov bot commented Sep 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.28%. Comparing base (078519c) to head (d41dafd).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5482      +/-   ##
==========================================
- Coverage   61.30%   61.28%   -0.02%     
==========================================
  Files         312      312              
  Lines       11070    11072       +2     
  Branches      773      758      -15     
==========================================
  Hits         6786     6786              
- Misses       4284     4286       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -22,7 +22,34 @@ val elements: SCollection[(String, String)] = sc.redis(connectionOptions, keyPat

Looking up specific keys from redis can be done with @scaladoc[RedisDoFn](com.spotify.scio.redis.RedisDoFn):

@@snip [RedisExamples.scala](/scio-examples/src/main/scala/com/spotify/scio/examples/extra/RedisExamples.scala) { #RedisLookup_example }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we go away from integrated snippets in the future?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, but they can't be in the Examples files. I think this was the only one and I added it only last year when doing doc cleanup.

@kellen kellen merged commit ebf9a63 into main Sep 12, 2024
12 checks passed
@kellen kellen deleted the kellen/examplesfix branch September 12, 2024 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants