Skip to content

docs: add hash examples notebook - #4228

Open
Brumbelow wants to merge 4 commits into
redis:masterfrom
Brumbelow:docs/hash-examples-notebook
Open

docs: add hash examples notebook#4228
Brumbelow wants to merge 4 commits into
redis:masterfrom
Brumbelow:docs/hash-examples-notebook

Conversation

@Brumbelow

@Brumbelow Brumbelow commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Description of change

Picks up #4154 by @baraiz, which has gone quiet for a few weeks. The notebook itself was already approved — the docs build failed only because it was committed without saved cell outputs, so nbsphinx tried to execute it in CI (no python3 kernel there), exactly as @petyaslavova diagnosed on that PR.

This keeps the original two commits and adds one on top that runs the notebook against a local Redis and saves the outputs, matching the other notebooks in docs/examples/.

Relates to #1744

Pull Request check-list

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Adds a Redis Hash examples notebook to the docs and wires it into the examples toctree via docs/examples.rst.

The notebook walks through common hash commands with redis-py (hset/hget, mapping, hexists, hkeys/hvals/hlen, hincrby, hdel, cleanup) using a user:1 profile-style key. Cell outputs are committed so nbsphinx can render the page in CI without executing against a live Redis, consistent with the other notebooks under docs/examples/.

Reviewed by Cursor Bugbot for commit c99d9c5. Bugbot is set up for automated code reviews on this repo. Configure here.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9db28066c1

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/examples/hash_examples.ipynb Outdated
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.

2 participants