Ensure the px.format_duration pxl function has its doc string set
#1411
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
Signed-off-by: Dom Del Nano <ddelnano@pixielabs.ai>
ddelnano
commented
Jun 2, 2023
| @@ -212,7 +212,6 @@ class PixieModule : public QLObject { | |||
| duration = px.format_duration(-5 * 60 * 1000 * 1000 * 1000) | |||
| # duration = "5m" duration is rounded down to nearest whole minute. | |||
| duration = px.parse_duration(-5 * 60 * 1000 * 1000 * 1000 + 5) | |||
|
|
|||
| # duration = "-5h" | |||
| duration = px.format_duration(-5 * 60 * 60 * 1000 * 1000 * 1000) | |||
There was a problem hiding this comment.
The //src/carnot/docstring:docstring command was failing without removing this whitespace.
vihangm
approved these changes
Jun 2, 2023
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.
Summary: Ensure the
px.format_durationpxl function has its doc string setWhen working on #1407 I noticed that the docs.px.dev site didn't include the
px.format_durationfunction despite being updated recently. This change addresses the issue causing the missing docs. Rather than updating the docs.px.dev site manually, I'll wait to propagate this change to that repo once #1408 is complete.Relevant Issues: N/A
Type of change: /kind bug
Test Plan: Verified that the function exists in the documentation json file (P401)