Skip to content

DOC-5472 time series doc examples #3443

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

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

andy-stark-redis
Copy link
Contributor

@andy-stark-redis andy-stark-redis commented Jul 23, 2025

DOC-5472

Go versions of the Python examples in the time series doc page.

Couple of things to note:

  • I've assumed that using 0 and math.MaxInt64 instead of - and + for minimum/maximum timestamps is OK (eg, line 211), but if there's a better way to specify this then let me know.
  • Some of the TSMGet/TSMRange examples return maps, so the ordering keys in nondeterministic. I've used code that's a bit more complicated than usual to print out the results in a deterministic way (eg, the example at line 438). If there's a simpler or more idiomatic way to handle this situation then I'll use that instead.

@andy-stark-redis andy-stark-redis marked this pull request as ready for review July 23, 2025 12:14
@andy-stark-redis andy-stark-redis requested a review from ndyakov July 23, 2025 12:14
@ndyakov
Copy link
Member

ndyakov commented Jul 24, 2025

Hello @andy-stark-redis , I will review this till end of week. Thank you.

Copy link
Member

@ndyakov ndyakov left a comment

Choose a reason for hiding this comment

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

@andy-stark-redis I left some styling suggestions on the first occurrences of the patterns that I observed. Feel free to address them for the rest of the examples. Mainly - remove empty lines before checking the error and if the method arguments are on multiple lines, keep them one per line. Other than that, looks good to me.

res6, err := rdb.TSAddWithArgs(
ctx,
"thermometer:3",
1, 10.4,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
1, 10.4,
1,
10.4,

Maybe it is slightly more readable on separate lines, let me know what you think.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ndyakov Yeah, I'm not 100% sure about this. The reason I formatted them like this was that the timestamp and value together form a logical pair. It's a bit like the following code from the hash examples:

hashFields := []string{
	"model", "Deimos",        // Key and value are just strings in the array but
	"brand", "Ergonom",      // this formatting emphasises the key-value pairs.
	"type", "Enduro bikes",
	"price", "4972",
}

But if it doesn't look like normal Go style to do it this way for the timestamps then I'll put them on separate lines.

Copy link
Member

Choose a reason for hiding this comment

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

I see your point. Since this is supposed to be part of the documentation, I assume it would be better to look similar to other language that have similar APIs. I personally would prefer separate lines for the current code, but do see the benefit of having them combined in the hash example that you shared.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, I'll use separate lines for this example. Thanks for clarifying this :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants