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

Pausable inline docs #9

Merged
merged 5 commits into from
Jan 13, 2025
Merged

Pausable inline docs #9

merged 5 commits into from
Jan 13, 2025

Conversation

ozgunozerk
Copy link
Collaborator

Fixes #8

@ozgunozerk ozgunozerk added the documentation Improvements or additions to documentation label Jan 10, 2025
@ozgunozerk ozgunozerk added this to the Release v0.1.0 milestone Jan 10, 2025
@ozgunozerk ozgunozerk requested a review from brozorec January 10, 2025 10:35
@ozgunozerk ozgunozerk self-assigned this Jan 10, 2025
Copy link
Collaborator

@brozorec brozorec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Like the tone, how design choices are well explained and the implementation tips 👍
  2. I'd recommend enabling in "rustfmt.toml":
wrap_comments = true
format_code_in_doc_comments = true

I tested out and don't see the issue stated here. The only point to consider is that code blocks (```) must be surrounded by empty lines in order for those rules to work fine.

@ozgunozerk ozgunozerk requested a review from brozorec January 10, 2025 17:54
@ozgunozerk ozgunozerk requested a review from brozorec January 13, 2025 10:55
@ozgunozerk ozgunozerk merged commit 302bff0 into main Jan 13, 2025
2 checks passed
@ozgunozerk ozgunozerk deleted the pausable-inline-docs branch January 13, 2025 12:43
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
Status: Done
Development

Successfully merging this pull request may close these issues.

🏗️ [Core Feature]: Add/improve inline docs for Pausable
2 participants