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

Standards for in-the-code documentation #118

Open
rgilman opened this issue Jun 6, 2019 · 1 comment
Open

Standards for in-the-code documentation #118

rgilman opened this issue Jun 6, 2019 · 1 comment

Comments

@rgilman
Copy link
Member

rgilman commented Jun 6, 2019

Today I added some comments to bfc-functions.php to clarify the purpose and add references to the various functions in that file. That's a useful start but it got me wondering about what our standards and understanding should be for doing this kind of documentation.

Thoughts?

@iangilman
Copy link
Member

The comments you added look good to me. I figure the best approach is to add comments as we feel they are needed and maybe over time a standard will evolve.

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

2 participants