Skip to content

Add missing newlines in api docstrings. #9562

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.

Sign up for GitHub

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

Open
jmcarp wants to merge 3 commits into
base: main
Choose a base branch
from
+146 −43
Open

Add missing newlines in api docstrings. #9562

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5abd754
Add missing newlines in api docstrings.
jmcarp Dec 23, 2025
b0ca8f5
More copy-edits from Claude.
jmcarp Dec 23, 2025
151c22c
More docs lint.
jmcarp Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions nexus/types/src/external_api/views.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,13 @@ pub struct SiloQuotas {
/// View of the current silo's resource utilization and capacity
#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
pub struct Utilization {
/// Accounts for resources allocated to running instances or storage allocated via disks or snapshots
/// Accounts for resources allocated to running instances or storage allocated via disks or snapshots.
///
/// Note that CPU and memory resources associated with a stopped instances are not counted here
/// whereas associated disks will still be counted
/// whereas associated disks will still be counted.
pub provisioned: VirtualResourceCounts,
/// The total amount of resources that can be provisioned in this silo
/// Actions that would exceed this limit will fail
/// The total amount of resources that can be provisioned in this silo.
/// Actions that would exceed this limit will fail.
pub capacity: VirtualResourceCounts,
}

Expand All @@ -104,8 +105,9 @@ pub struct Utilization {
pub struct SiloUtilization {
pub silo_id: Uuid,
pub silo_name: Name,
/// Accounts for resources allocated by in silos like CPU or memory for running instances and storage for disks and snapshots
/// Note that CPU and memory resources associated with a stopped instances are not counted here
/// Accounts for resources allocated by in silos like CPU or memory for running instances and storage for disks and snapshots.
///
/// Note that CPU and memory resources associated with a stopped instances are not counted here.
Copy link
Contributor

@david-crespo david-crespo Dec 23, 2025

Choose a reason for hiding this comment

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

a stopped instances

pub provisioned: VirtualResourceCounts,
/// Accounts for the total amount of resources reserved for silos via their quotas
pub allocated: VirtualResourceCounts,
Expand Down
Loading