Skip to content

controller: Add some missing doc comments #35012

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
ggevay wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −10
Open

controller: Add some missing doc comments #35012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions src/compute-client/src/controller/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ impl From<CollectionMissing> for CollectionLookupError {
/// Errors arising during compute replica creation.
#[derive(Error, Debug)]
pub enum ReplicaCreationError {
/// TODO(database-issues#7533): Add documentation.
/// The target compute instance does not exist.
#[error("instance does not exist: {0}")]
InstanceMissing(ComputeInstanceId),
/// TODO(database-issues#7533): Add documentation.
/// A replica with the given ID already exists on the target instance.
#[error("replica exists already: {0}")]
ReplicaExists(ReplicaId),
}
Expand All @@ -97,10 +97,10 @@ impl From<InstanceMissing> for ReplicaCreationError {
/// Errors arising during compute replica removal.
#[derive(Error, Debug)]
pub enum ReplicaDropError {
/// TODO(database-issues#7533): Add documentation.
/// The target compute instance does not exist.
#[error("instance does not exist: {0}")]
InstanceMissing(ComputeInstanceId),
/// TODO(database-issues#7533): Add documentation.
/// The replica to be dropped does not exist on the target instance.
#[error("replica does not exist: {0}")]
ReplicaMissing(ReplicaId),
}
Expand Down Expand Up @@ -183,10 +183,10 @@ impl From<CollectionMissing> for PeekError {
/// Errors arising during collection updates.
#[derive(Error, Debug)]
pub enum CollectionUpdateError {
/// TODO(database-issues#7533): Add documentation.
/// The target compute instance does not exist.
#[error("instance does not exist: {0}")]
InstanceMissing(ComputeInstanceId),
/// TODO(database-issues#7533): Add documentation.
/// The collection to be updated does not exist.
#[error("collection does not exist: {0}")]
CollectionMissing(GlobalId),
}
Expand All @@ -206,13 +206,13 @@ impl From<CollectionMissing> for CollectionUpdateError {
/// Errors arising during collection read policy assignment.
#[derive(Error, Debug)]
pub enum ReadPolicyError {
/// TODO(database-issues#7533): Add documentation.
/// The target compute instance does not exist.
#[error("instance does not exist: {0}")]
InstanceMissing(ComputeInstanceId),
/// TODO(database-issues#7533): Add documentation.
/// The collection does not exist.
#[error("collection does not exist: {0}")]
CollectionMissing(GlobalId),
/// TODO(database-issues#7533): Add documentation.
/// The collection is write-only and does not support read policies.
#[error("collection is write-only: {0}")]
WriteOnlyCollection(GlobalId),
}
Expand All @@ -232,7 +232,7 @@ impl From<CollectionMissing> for ReadPolicyError {
/// Errors arising during orphan removal.
#[derive(Error, Debug)]
pub enum RemoveOrphansError {
/// TODO(database-issues#7533): Add documentation.
/// An error occurred in the orchestrator while removing orphaned replicas.
#[error("orchestrator error: {0}")]
OrchestratorError(anyhow::Error),
}
Expand Down