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

chore: cleanup documentation examples #878

Merged
merged 1 commit into from
Oct 20, 2023
Merged

Conversation

ivokub
Copy link
Collaborator

@ivokub ivokub commented Oct 20, 2023

Description

Cleaned up the examples in the documentation. Removed print lines to make the examples more succinct and removed "Output" comments from slow examples to speed up testing.

Type of change

  • Refactoring

Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I did not modify files generated from templates
  • golangci-lint does not output errors locally
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@ivokub ivokub self-assigned this Oct 20, 2023
@ivokub ivokub marked this pull request as ready for review October 20, 2023 09:52
@ivokub ivokub requested a review from Tabaie October 20, 2023 10:02
@ivokub ivokub added consolidate strengthen an existing feature doc P3: Low Issue priority: low labels Oct 20, 2023
@Tabaie Tabaie merged commit 4dbc3c6 into master Oct 20, 2023
6 checks passed
@Tabaie Tabaie deleted the chore/example-cleanup branch October 20, 2023 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consolidate strengthen an existing feature doc P3: Low Issue priority: low
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants