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

Standardize example code comments across repos #129

Open
libutcher opened this issue Oct 15, 2024 · 0 comments
Open

Standardize example code comments across repos #129

libutcher opened this issue Oct 15, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@libutcher
Copy link
Contributor

Current Behavior

The code comments in our example files currently use different wording, and some examples are missing code comments.

Desired Behavior

We should make sure all have comments and that we're using the same wording.

Benefits & Value

This will ensure code examples are standardized when they're pulled into the documentation, and provide useful context for users.

Additional information

No response

@libutcher libutcher added the documentation Improvements or additions to documentation label Oct 15, 2024
@libutcher libutcher self-assigned this Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant