Fix typos and grammar in docstrings

[vojtechtrefny]

Fixed spelling errors ("give" -> "given", "Selfpereserving" -> "Self-preserving"), grammar errors ("an new" -> "a new"), and removed extra spaces in documentation.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Corrected grammar, spelling, and formatting in documentation comments across plugins and plugin APIs for clearer, more consistent wording; expanded guidance about Host NQN behavior. No functional, API, or behavior changes.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[gemini-code-assist]

Summary of Changes

Hello @vojtechtrefny, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the quality and readability of the codebase's documentation by addressing minor linguistic and formatting issues. The changes include correcting spelling mistakes, rectifying grammatical errors, and eliminating unnecessary whitespace within docstrings, ensuring that the embedded documentation is clear, precise, and consistent.

Highlights

• Typo Corrections: Fixed spelling errors such as 'give' to 'given' and 'Selfpereserving' to 'Self-preserving' in various docstrings.
• Grammar Improvements: Corrected grammatical inaccuracies, specifically changing 'an new' to 'a new' for better English usage.
• Formatting Cleanup: Removed extraneous spaces within docstrings across multiple files to improve readability and consistency.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[coderabbitai]

Walkthrough

Several documentation/comment-only edits across loop, NVMe and SMART plugins and associated plugin API files; fixes are typographic and formatting-only. No code, behavior, API signatures, or error handling were changed.

Changes

Cohort / File(s)	Summary
Loop plugin docs src/plugins/loop.c, src/plugins/loop.h, src/lib/plugin_apis/loop.api	Corrected typos in bd_loop_setup_from_fd Returns and BDLoopInfo comment: "an new" → "a new"; "give" → "given".
NVMe plugin docs & API src/plugins/nvme/nvme-fabrics.c, src/plugins/nvme/nvme.h, src/lib/plugin_apis/nvme.api	Reformatted and unified parameter/comment lines: transport_svcid description condensed to one line; removed extra spacing in BD_NVME_SMART_CRITICAL_WARNING_DEGRADED; expanded/clarified @host_nqn guidance in nvme.api documentation.
SMART plugin docs & API src/plugins/smart/smart.h, src/lib/plugin_apis/smart.api	Fixed spelling/formatting in SMART comments: "Selfpereserving" → "Self-preserving" and normalized spacing in SCSI informational exception descriptions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Changes are documentation-only but spread across multiple plugin sources and API files.
• Pay extra attention to:
  • The expanded @host_nqn text in src/lib/plugin_apis/nvme.api to confirm wording matches intended behavior.
  • Consistency of small wording/spacing fixes in related header and .api files.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: fixing typos and grammar errors throughout docstrings across multiple files (loop, nvme, smart plugins and their API files).

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Code Review

This pull request correctly fixes several typos, grammatical errors, and extra spaces in the documentation comments. The changes are appreciated and improve the overall quality of the code's documentation. However, the fixes appear to be incomplete. I've noticed that the same errors are present in the corresponding .api files (e.g., src/lib/plugin_apis/loop.api, src/lib/plugin_apis/nvme.api, and src/lib/plugin_apis/smart.api), which were not part of this pull request. For instance, 'Selfpereserving' was corrected in src/plugins/smart/smart.h but remains in src/lib/plugin_apis/smart.api. To ensure consistency across the codebase, I recommend updating these .api files as well, possibly in this same pull request.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/lib/plugin_apis/nvme.api (1)

1270-1278: Minor grammar tweak for @transport_svcid description (optional)

The current text is understandable but slightly off grammatically (“port number … is 4420 and 8009 respectively”). Consider this wording instead:

- * @transport_svcid: (nullable): The transport service ID. For transports using IP addressing (e.g. `tcp`, `rdma`) this field is the port number. The default port number for the `tcp` and `rdma` transports is `4420` and `8009` respectively when the well-known Discovery NQN is specified.
+ * @transport_svcid: (nullable): The transport service ID. For transports using IP addressing (e.g. `tcp`, `rdma`) this field is the port number. The default port numbers for the `tcp` and `rdma` transports are `4420` and `8009`, respectively, when the well-known Discovery NQN is specified.

If you prefer not to touch this again in this PR, it’s safe to leave as-is.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c8b0cea and d7bd9f2.

📒 Files selected for processing (8)

• src/lib/plugin_apis/loop.api (1 hunks)
• src/lib/plugin_apis/nvme.api (2 hunks)
• src/lib/plugin_apis/smart.api (2 hunks)
• src/plugins/loop.c (1 hunks)
• src/plugins/loop.h (1 hunks)
• src/plugins/nvme/nvme-fabrics.c (1 hunks)
• src/plugins/nvme/nvme.h (1 hunks)
• src/plugins/smart/smart.h (2 hunks)

✅ Files skipped from review due to trivial changes (2)

• src/lib/plugin_apis/loop.api
• src/lib/plugin_apis/smart.api

🚧 Files skipped from review as they are similar to previous changes (4)

• src/plugins/loop.c
• src/plugins/loop.h
• src/plugins/nvme/nvme.h
• src/plugins/nvme/nvme-fabrics.c

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (16)

• GitHub Check: compilation (gcc-10)
• GitHub Check: compilation (clang-18)
• GitHub Check: compilation (clang-14)
• GitHub Check: compilation (clang-17)
• GitHub Check: compilation (gcc-14)
• GitHub Check: compilation (gcc-12)
• GitHub Check: compilation (gcc-11)
• GitHub Check: compilation (clang-16)
• GitHub Check: compilation (gcc-13)
• GitHub Check: compilation (clang-15)
• GitHub Check: Analyze (cpp)
• GitHub Check: blivet-tests
• GitHub Check: csmock
• GitHub Check: udisks-build
• GitHub Check: Analyze (python)
• GitHub Check: symbols

🔇 Additional comments (2)

src/plugins/smart/smart.h (1)

138-146: Docstring spelling/spacing fixes look good

BD_SMART_ATA_ATTRIBUTE_FLAG_SELF_PRESERVING description now has correct “Self-preserving” spelling, and the NV cache degraded power informational-exception text reads cleanly with consistent spacing. No API or semantic impact.

Also applies to: 232-243

src/lib/plugin_apis/nvme.api (1)

451-457: NVMe SMART degraded-warning description is clear and correct

The updated BD_NVME_SMART_CRITICAL_WARNING_DEGRADED text is grammatically sound and matches expected NVMe semantics; this is a harmless formatting/clarity improvement only.