fx icon indicating copy to clipboard operation
fx copied to clipboard

Clarify example "Export boundary functions"

Open JamesSlocumIH opened this issue 1 year ago • 1 comments

The following example is confusing.

  • If Config is supposed to be a parameter object, it should be named Params since the constructor is called New(...) and needs defined fx.In within.
  • If it is not meant to be an parameter object, I think passing Params into the constructor without defining that in the example is confusing.
    • Maybe we should be passing a Config instead? i.e. New(c Config)

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.

JamesSlocumIH avatar Jun 27 '24 16:06 JamesSlocumIH

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Jun 27 '24 16:06 CLAassistant