fx
fx copied to clipboard
Clarify example "Export boundary functions"
The following example is confusing.
- If
Configis supposed to be a parameter object, it should be namedParamssince the constructor is calledNew(...)and needs definedfx.Inwithin. - If it is not meant to be an parameter object, I think passing
Paramsinto the constructor without defining that in the example is confusing.- Maybe we should be passing a
Configinstead? i.e.New(c Config)
- Maybe we should be passing a
I changed the example to use a parameter object, because I think using the parameter object makes sense here. I think if its not supposed to use a parameter object, updating the names of Params or Config to align could help make the example more clear.