Doc 3787 enable json samples #227
Conversation
andy-stark-redis
added
the
documentation
|
The staging link for the path page shows glitches for some of the Filter examples but they work in a local build and I can't find anything wrong with the syntax :-( |
dwdougherty
left a comment
dwdougherty
left a comment
There was a problem hiding this comment.
These need some work. In some cases, answers differ between redis-cli and Python. In other cases, the entire script is displayed instead of just the required snippet (this is usually a problem with mismatched tags in the Python code).
Let's hop on a Slack call @andy-stark-redis and go through them.
|
Shortening the CLI examples seems to have fixed the Python examples for some reason... |
|
Weird. |
| with [`JSON.GET`]({{< baseurl >}}/commands/json.get/): | ||
|
|
||
| ```sh | ||
| {{< clients-example cli only >}} |
There was a problem hiding this comment.
Just curious: what was the impetus for this change? If an example is clearly CLI only, as this one is, I don't think it makes sense to use the clients-example shortcode. Change my mind. :)
There was a problem hiding this comment.
:-D I don't know if it will change your mind or not but I thought it was helpful to see the legend "Redis CLI" explicitly at the top given that most samples in the page are for both CLI and other languages. I can remove it if it's out of step with what we do elsewhere.
|
Sorry @andy-stark-redis, but we need to chat about this some more. I'll try to catch you before tomorrow afternoon's meetings. |
dwdougherty
left a comment
dwdougherty
left a comment
There was a problem hiding this comment.
LGTM. Thanks, @andy-stark-redis, for being patient with all the back and forth! :)
|
Not at all, @dwdougherty ! Thanks very much to you for patiently guiding me to the right solution :-) |
We had existing code samples for the JSON datatype pages in the redis-py repo but the doc page wasn't set up to use them. Both the doc page and the Python code needed fixes to get them into shape. The Python stuff is already accepted and merged into redis-py and this PR contains the corresponding doc page changes.