Skip to content

Commit 7a0c370

Browse files
committed
Rename RelUser -> RelatedUser for clarity and improve documentation.
1 parent 3c1dd7a commit 7a0c370

File tree

5 files changed

+13
-10
lines changed

5 files changed

+13
-10
lines changed

RedditSharp/Moderator Actions/ModeratorUser.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace RedditSharp
77
/// <summary>
88
/// Represents a moderator.
99
/// </summary>
10-
public class ModeratorUser : RelUser
10+
public class ModeratorUser : RelatedUser
1111
{
1212
public ModeratorUser(IWebAgent agent, JToken json) : base(agent, json)
1313
{

RedditSharp/Things/Contributor.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace RedditSharp.Things
88
/// <summary>
99
/// A contributor to a subreddit.
1010
/// </summary>
11-
public class Contributor : RelUser
11+
public class Contributor : RelatedUser
1212
{
1313
/// <inheritdoc />
1414
public Contributor(IWebAgent agent, JToken json) : base(agent, json) {

RedditSharp/Things/RedditUser.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,12 @@ public RedditUser(IWebAgent agent, JToken json) : base(agent, json)
3131
internal override JToken GetJsonData(JToken json) => json["name"] == null ? json["data"] : json;
3232

3333
/// <summary>
34-
/// This method has no effect.
34+
/// This method returns itself as the full <see cref="RedditUser"/> is
35+
/// already initalized so no more further initialization needs to
36+
/// be done.
3537
/// </summary>
3638
/// <returns>This same <see cref="RedditUser"/>.</returns>
39+
/// <seealso cref="PartialUser.GetFullUserAsync"/>
3740
public override Task<RedditUser> GetFullUserAsync() => Task.FromResult(this);
3841

3942
/// <summary>

RedditSharp/Things/User/NotedUser.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace RedditSharp.Things.User
66
{
7-
public class NotedUser : RelUser
7+
public class NotedUser : RelatedUser
88
{
99
public NotedUser(IWebAgent agent, JToken json) : base(agent, json)
1010
{

RedditSharp/Things/User/RelUser.cs renamed to RedditSharp/Things/User/RelatedUser.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55
namespace RedditSharp.Things.User
66
{
77
/// <summary>
8-
/// Represents a user that was added to a user list or listing at a
9-
/// time.
8+
/// Represents a user that has a relationship formed with another thing,
9+
/// usually with a <see cref="Subreddit"/> or another <see cref="RedditUser"/>.
1010
/// </summary>
11-
public class RelUser : PartialUser
11+
public class RelatedUser : PartialUser
1212
{
13-
public RelUser(IWebAgent agent, JToken json) : base(agent, json)
13+
public RelatedUser(IWebAgent agent, JToken json) : base(agent, json)
1414
{
1515
}
1616

1717
/// <summary>
18-
/// The base-36 fullname of the rel item
18+
/// The base-36 fullname of the related item
1919
/// </summary>
2020
[JsonProperty("rel_id")]
21-
public String RelFullName { get; internal set; }
21+
public String RelatedFullName { get; internal set; }
2222

2323
/// <summary>
2424
/// UTC time of when this user was added to the list

0 commit comments

Comments
 (0)