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

docs(all): tag examples with @example #3391

Merged
merged 2 commits into from
Jan 7, 2025

Conversation

griest024
Copy link
Member

@griest024 griest024 commented Jan 3, 2025

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the new behavior?

Usage examples embedded in API docs are tagged with @example

Part of: #3390

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

This does not include design, which will be handled by @xelaint

@griest024 griest024 self-assigned this Jan 3, 2025
@griest024 griest024 requested review from a team as code owners January 3, 2025 20:28
@griest024 griest024 merged commit 52f4973 into graycoreio:develop Jan 7, 2025
54 checks passed
@griest024 griest024 deleted the docs/all/examples branch January 9, 2025 20:48
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

Successfully merging this pull request may close these issues.

1 participant