Elmish.WPF icon indicating copy to clipboard operation
Elmish.WPF copied to clipboard

Documentation for Binding module functions

Open LyndonGingerich opened this issue 2 years ago • 3 comments

The Binding module contains many functions undocumented in the tutorial. Particularly, the tutorial says, "Note: Lazy bindings may get a complete overhaul soon; see https://github.com/elmish/Elmish.WPF/issues/143," which issue is closed, but Binding.addLazy is still not documented. Where should such documentation be added?

The tutorial, I think, has somewhat outgrown its name and become a reference of sorts. Should we extract a reference and document the Binding functions there?

  • [x] https://github.com/elmish/Elmish.WPF/pull/521
  • [x] https://github.com/elmish/Elmish.WPF/pull/525
  • [x] https://github.com/elmish/Elmish.WPF/pull/528
  • [ ] Document other Bindings functions

LyndonGingerich avatar Sep 30 '22 14:09 LyndonGingerich

The tutorial mostly predates the binding module.

You can do whatever you think is best with the documentation.

TysonMN avatar Oct 01 '22 04:10 TysonMN

I'm delaying until the static bindings are implemented. I think we could probably generate documentation from the function XML comments.

LyndonGingerich avatar Apr 19 '23 20:04 LyndonGingerich

@LyndonGingerich You don't need to delay anymore.

marner2 avatar May 12 '23 16:05 marner2