Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Binding module functions #520

Open
3 of 4 tasks
LyndonGingerich opened this issue Sep 30, 2022 · 3 comments
Open
3 of 4 tasks

Documentation for Binding module functions #520

LyndonGingerich opened this issue Sep 30, 2022 · 3 comments

Comments

@LyndonGingerich
Copy link
Contributor

LyndonGingerich commented Sep 30, 2022

The Binding module contains many functions undocumented in the tutorial. Particularly, the tutorial says, "Note: Lazy bindings may get a complete overhaul soon; see #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
Copy link
Member

TysonMN commented Oct 1, 2022

The tutorial mostly predates the binding module.

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

@LyndonGingerich
Copy link
Contributor Author

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

@marner2 marner2 mentioned this issue May 12, 2023
41 tasks
@marner2
Copy link
Collaborator

marner2 commented May 12, 2023

@LyndonGingerich You don't need to delay anymore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants