Skip to content

Commit

Permalink
Add short description for format_duration pxl function documentation (p…
Browse files Browse the repository at this point in the history
…ixie-io#1548)

Summary: Add short description for format_duration pxl function
documentation

This is to pull in an update that was made in this commit
(pixie-io/docs.px.dev@0fd2b8b).

Relevant Issues: N/A

Type of change: /kind cleanup

Test Plan: Regenerated the docs and verified that there is only
whitespace changes between github.com/pixie-io/docs.px.dev and the files
generated from this repo
```
cd bazel-bin; ./src/carnot/docstring/docstring_/docstring
mv output.json ~/code/docs.px.dev/external/pxl_documentation.json
ddelnano@vigenere:~/code/docs.px.dev (main) $ git diff
diff --git a/external/pxl_documentation.json b/external/pxl_documentation.json
index dea613c..76f763b 100644
--- a/external/pxl_documentation.json
+++ b/external/pxl_documentation.json
@@ -8255,4 +8255,4 @@
       }
     ]
   }
-}
+}
\ No newline at end of file

```

Signed-off-by: Dom Del Nano <ddelnano@pixielabs.ai>
  • Loading branch information
ddelnano authored Jun 21, 2023
1 parent 5989d85 commit dc8d08d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/carnot/planner/objects/pixie_module.h
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,8 @@ class PixieModule : public QLObject {

inline static constexpr char kFormatDurationOpID[] = "format_duration";
inline static constexpr char kFormatDurationDocstring[] = R"doc(
Convert a duration in nanoseconds to a duration string.
Convert an integer in nanoseconds (-3,000,000,000) to a duration string ("-5m") while
preserving the sign. This function converts to whole milliseconds, seconds, minutes,
hours or days. This means it will round down to the nearest whole number time unit.
Expand Down

0 comments on commit dc8d08d

Please sign in to comment.