XML documentation updates #139
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add missing XML documentation. Add some missing parameter validation. Updates to grammar in some error messages. Fix some incorrect XML documentation. Make StatsDMessageFormatter internal (so we don't have to document it). Add some extra overloads to TimerExtensions to remove the need to have a parameter for IDisposableTimer if you aren't going to use it, which can help save on allocations. Relates to #130.
|
The idea behind the new timer overloads is so where before you did this: public void MyMethod()
{
// Whatever
]
public void MyOtherMethod()
{
publisher.Time("mymethod", _ => MyMethod());
}Now you can just do this: public void MyMethod()
{
// Whatever
]
public void MyOtherMethod()
{
publisher.Time("mymethod", MyMethod);
}This removes the need for the compiler to allocate extra delegates to deal with the anonymous lambda required to deal with the |
| public interface IDisposableTimer : IDisposable | ||
| { | ||
| /// <summary> | ||
| /// Gets the name of the statsd bucket associated with the timer. |
There was a problem hiding this comment.
"Gets or sets the name" ? It's writable so that you can alter the stat name based on eg. http response code inside the block being timed.
There was a problem hiding this comment.
One day I'll convince people StyleCop's a good idea, and that would've found this for me.
|
The new overloads seem fine. I left one comment. The rest is good too! |
AnthonySteele
approved these changes
Oct 10, 2018
Note that the property is a setter as well as a getter.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
StatsDMessageFormatterinternal (so we don't have to document it).TimerExtensionsto remove the need to have a parameter forIDisposableTimerif you aren't going to use it, which can help save on allocations for delegates if you don't otherwise need a lambda.Relates to #130.