Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove wrong tag #1699

Merged
merged 2 commits into from Jul 25, 2022
Merged

Remove wrong tag #1699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2cbe77
Remove wrong tag
sungam3r Jul 15, 2022
180e81e
fix
sungam3r Jul 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions src/Serilog/Core/Enrichers/PropertyEnricher.cs
View file
Open in desktop
Expand Up @@ -32,11 +32,9 @@ public class PropertyEnricher : ILogEventEnricher
/// </summary>
/// <param name="name">The name of the property.</param>
/// <param name="value">The value of the property.</param>
/// <returns>A handle to later remove the property from the context.</returns>
/// <param name="destructureObjects">If true, and the value is a non-primitive, non-array type,
/// then the value will be converted to a structure; otherwise, unknown types will
/// be converted to scalars, which are generally stored as strings.</param>
Copy link
Member

Choose a reason for hiding this comment

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

is L39 superfluous too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

EnsureValidName throws this exception

Copy link
Member

Choose a reason for hiding this comment

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

Apologies; L38 in your version, i.e. wondering (without having it in an IDE) whether /// <returns></returns> is necessary before the exception list (there isn't one before the method after, but perhaps it is necessary for a ctor)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ooops, fixed

/// <returns></returns>
/// <exception cref="ArgumentNullException">When <paramref name="name"/> is <code>null</code></exception>
/// <exception cref="ArgumentException">When <paramref name="name"/> is empty or only contains whitespace</exception>
public PropertyEnricher(string name, object value, bool destructureObjects = false)
Expand Down
6 changes: 3 additions & 3 deletions src/Serilog/Core/ILogEventPropertyFactory.cs
View file
Open in desktop
@@ -1,4 +1,4 @@
// Copyright 2013-2015 Serilog Contributors
// Copyright 2013-2015 Serilog Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -30,7 +30,7 @@ public interface ILogEventPropertyFactory
/// <param name="destructureObjects">If true, and the value is a non-primitive, non-array type,
/// then the value will be converted to a structure; otherwise, unknown types will
/// be converted to scalars, which are generally stored as strings.</param>
/// <returns></returns>
/// <returns>Created <see cref="LogEventProperty"/> instance.</returns>
LogEventProperty CreateProperty(string name, object value, bool destructureObjects = false);
}
}
}