Skip to content

Conversation

@SophiaC42
Copy link

No description provided.

@adalon
Copy link
Collaborator

adalon commented Apr 21, 2020

Let's remove the hasn't been reviewed yet suffix from the commit message


namespace Guit
{
/// <summary>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's remove this empty comment

@adalon
Copy link
Collaborator

adalon commented Apr 21, 2020

@SophiaC42 we should moved the source comments into the IGitRepository interface:

https://github.com/kzu/guit/blob/master/src/Guit.Core/IGitRepository.cs

Since what we usually document is the public interface and not the implementation.

GitRepository implementation methods could use the notation:

https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/inheritdoc

e.g.

image

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.

2 participants