Documenting function parameter types and returns #1071
Conversation
|
This addresses #1026 |
docs/expressions.md
Outdated
There was a problem hiding this comment.
Should we have a format when strings have a predefined set of values. So for sort the asc desc, lsstat is has a set as well.
There was a problem hiding this comment.
I'm not sure how to define it. The description makes it pretty clear what to do.
There was a problem hiding this comment.
something like regex syntax: /"(asc|desc)"/
or Powershell validation sets: [ValidateSet("Steve","Mary")]
There was a problem hiding this comment.
And I disagree that the description is clear. You should be able to call a function knowing only it's signature, and asc_desc is not a defined type. If you want to do that you should do what .NET and Go do and use enums or consts instead of strings
There was a problem hiding this comment.
I like the Piped version (Minus the escapes and quotes, so
(asc|desc) string
On Mon, Jun 15, 2015 at 3:40 PM, Greg Bray notifications@github.com wrote:
In docs/expressions.md
#1071 (comment):Change the NaN value during binary operations (when joining two queries) of unknown groups to the scalar. This is useful to prevent unknown group and other errors from bubbling up.
-## sort(number, asc_desc)
+## sort(numberSet, asc_desc string) numberSetsomething like regex syntax: "(asc|desc)"\
or Powershell validation sets: [ValidateSet("Steve","Mary")]
—
Reply to this email directly or view it on GitHub
https://github.com/bosun-monitor/bosun/pull/1071/files#r32475366.
|
@captncraig Looking good - much appreciated. Ship at will |
|
Agreed... looks much better! Great work! |
Documenting function parameter types and returns
This also includes formally renaming Number to NumberSet to cause less confusion.