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: Switch on missing_docs #106

Merged
merged 3 commits into from
Dec 12, 2024
Merged

chore: Switch on missing_docs #106

merged 3 commits into from
Dec 12, 2024

Conversation

vrongmeal
Copy link
Member

Resolves: #29

Resolves: #29

Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal vrongmeal requested a review from a team as a code owner December 12, 2024 16:42
@vrongmeal
Copy link
Member Author

Apart from proto struct headings, I don't think anything else should be left.

Comment on lines +1585 to 1591
/// Name of a basin.
///
/// Must be between 8 and 48 characters in length. Must comprise lowercase
/// letters, numbers, and hyphens. Cannot begin or end with a hyphen.
#[derive(Debug, Clone)]
pub struct BasinName(String);

Copy link
Member

Choose a reason for hiding this comment

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

ah this duplicates with what sync_docs syncs on CreateBasinRequest

Copy link
Member Author

@vrongmeal vrongmeal Dec 12, 2024

Choose a reason for hiding this comment

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

Some duplication is inevitable I suppose. The CreateBasinRequest has:

/// Basin name, which must be globally unique. It can be omitted to let the service assign a unique name.

which is irrelevant.

Signed-off-by: Vaibhav Rabber <[email protected]>
Signed-off-by: Vaibhav Rabber <[email protected]>
Copy link
Member

@infiniteregrets infiniteregrets left a comment

Choose a reason for hiding this comment

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

LGTM!

@vrongmeal vrongmeal merged commit 87960b9 into main Dec 12, 2024
3 checks passed
@vrongmeal vrongmeal deleted the vrongmeal/docs branch December 12, 2024 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review API docs
2 participants