search

elmish / Elmish.WPF

Static WPF views for elmish programs
Other
430 stars 71 forks source link

Documentation for Binding module functions #520

Open LyndonGingerich opened 2 years ago

LyndonGingerich commented 2 years ago

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?

TysonMN commented 2 years ago

The tutorial mostly predates the binding module.

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

LyndonGingerich commented 1 year ago

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

marner2 commented 1 year ago

@LyndonGingerich You don't need to delay anymore.