corvus-dotnet / corvus-dotnet/Corvus.Tenancy

ITenantProvider xmldoc should describe expected exceptions

Open
#38 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
C#
Stars
6
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Various methods in `ITenantProvider` can throw `TenantNotFoundException` but tthis is not mentioned in the XML doc comments. It should be, because this is an important aspect of the contract for this interface.

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the ITenantProvider interface and review its XML documentation alongside TenantNotFoundException. Update the relevant method comments to describe the expected exception, then verify that all methods that can throw it are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.