add comments to audit module#7635
Conversation
| public virtual int Id { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// The happend time of the event. |
There was a problem hiding this comment.
Bad English, rephrase as:
"The time when the event occurred."
| public virtual DateTime CreatedUtc { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// The user name of the user who made the event.. |
There was a problem hiding this comment.
Better phrased as:
"The user name of the user who caused the event to occur."
And remove double periods at the end.
| public virtual string Comment { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// The ip address of the user who made the event. |
There was a problem hiding this comment.
Rephrase as:
"The IP adress of the user who caused the event to occur."
| @@ -1,6 +1,16 @@ | |||
| namespace Orchard.AuditTrail.Models { | |||
There was a problem hiding this comment.
Apply trailing periods consistently.
|
|
||
| namespace Orchard.AuditTrail.Services { | ||
| /// <summary> | ||
| /// Serialize or deserialize event data. |
There was a problem hiding this comment.
Dependencies should be described with more context IMO. Perhaps better phrased as something like:
"A service responsible for serializing and deserializing audit trail event data."
|
I like the initiative of providing XML comments! I've written a few comments - if you could go over the PR and make it a bit more consistent with regards to punctuation etc, that would be truly great! |
|
Nice work, thanks. |
3 participants
No description provided.