-
Notifications
You must be signed in to change notification settings - Fork 13
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
feat: Topics #13
feat: Topics #13
Conversation
All methods are implemented as of this commit. There is still work to be done on proper error handling and documentation.
NovuClient = novu; | ||
} | ||
|
||
public async void Dispose() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason why this function is empty?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you implement the IDisposable
interface on a text fixture, the method is required to be implemented as part of testing cleanup. However, we do not have anything to clean up after running this test. We have to implement IDisposable
in order for xunit
to pick up the fixture an use it as a dependency injection so we don't have to create new clients on each test and we can use the shared client through all tests in that class.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay thanks for the clarification
/// <example> | ||
/// <para> | ||
/// <code> | ||
/// var topicRequest = new TopicCreateDto | ||
/// { | ||
/// Key = $"test:topic:{Guid.NewGuid().ToString()}", | ||
/// Name = "Test Topic", | ||
/// }; | ||
/// | ||
/// var topic = await client.Topic.CreateTopicAsync(topicRequest); | ||
/// </code> | ||
/// </para> | ||
/// </example> | ||
/// <param name="dto"> | ||
/// <see cref="TopicCreateDto"/> | ||
/// </param> | ||
/// <returns> | ||
/// <see cref="TopicCreateResponseDto"/> | ||
/// </returns> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any particular reason why we have the docblocks like this in different html tags?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These generate intellisense snippets like this:
It is also required for future docfx
implementation for automatic documentation.
C# Comments: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't have them in the other code, so I was wondering why we need them all of a sudden now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please can you update the readme as well?
No description provided.