zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-05 11:40:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

tweak comments

Browse Source
This commit is contained in:
Ryan Gribble
2016-08-10 21:17:52 +10:00
parent 7bc44d4119
commit 6ebf1939b6
2 changed files with 26 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit/Models/Request/BranchProtectionUpdate.cs
+7 -7
View File
@@ -15,7 +15,7 @@ namespace Octokit
/// <summary>
/// Create a BranchProtection update request
/// </summary>
/// <param name="requiredStatusChecks">Specifies the requested status check settings</param>
/// <param name="requiredStatusChecks">Specifies the requested status check settings. Pass null to disable status checks</param>
public BranchProtectionSettingsUpdate(BranchProtectionRequiredStatusChecksUpdate requiredStatusChecks)
{
RequiredStatusChecks = requiredStatusChecks;
@@ -25,8 +25,8 @@ namespace Octokit
/// <summary>
/// Create a BranchProtection update request
/// </summary>
/// <param name="requiredStatusChecks">Specifies the requested status check settings. Pass null to disable status checks</param>
/// <param name="restrictions">Specifies the requested push access restrictions (applies only to Organization owned repositories). Pass null to disable push access restrictions</param>
/// <param name="requiredStatusChecks">Specifies the requested status check settings. Pass null to disable status checks</param>
/// <param name="restrictions">Specifies the requested push access restrictions (applies only to Organization owned repositories). Pass null to disable push access restrictions</param>
public BranchProtectionSettingsUpdate(BranchProtectionRequiredStatusChecksUpdate requiredStatusChecks, ProtectedBranchRestrictionsUpdate restrictions)
{
RequiredStatusChecks = requiredStatusChecks;
@@ -34,7 +34,7 @@ namespace Octokit
}
/// <summary>
/// Status check settings for protected branch
/// Status check settings for the protected branch
/// </summary>
[SerializeNull]
public BranchProtectionRequiredStatusChecksUpdate RequiredStatusChecks { get; protected set; }
@@ -55,7 +55,7 @@ namespace Octokit
}
/// <summary>
/// Specifies the requested status check settings for branch protection
/// Specifies settings for status checks which must pass before branches can be merged into the protected branch
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class BranchProtectionRequiredStatusChecksUpdate
@@ -98,13 +98,13 @@ namespace Octokit
}
/// <summary>
/// Specifies people or teams allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail.
/// Specifies people or teams allowed to push to the protected branch. Required status checks will still prevent these people from merging if the checks fail
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class ProtectedBranchRestrictionsUpdate
{
/// <summary>
/// Specify people or teams (in addition to Administrators) allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail.
/// Specify people or teams (in addition to Administrators) allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail
/// </summary>
/// <param name="teams">Teams allowed to push to this branch (pass empty array if no teams)</param>
/// <param name="users">Users allowed to push to this branch (pass empty array if no users)</param>
Octokit/Models/Response/BranchProtection.cs
+19 -3
View File
@@ -124,11 +124,17 @@ namespace Octokit
{
get
{
return String.Format(CultureInfo.InvariantCulture, "StatusChecks: {0} Restrictions: {1}", RequiredStatusChecks.DebuggerDisplay, Restrictions.DebuggerDisplay);
return String.Format(CultureInfo.InvariantCulture,
"StatusChecks: {0} Restrictions: {1}",
RequiredStatusChecks == null ? "disabled" : RequiredStatusChecks.DebuggerDisplay,
Restrictions == null ? "disabled" : Restrictions.DebuggerDisplay);
}
}
}
/// <summary>
/// Specifies settings for status checks which must pass before branches can be merged into the protected branch
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class BranchProtectionRequiredStatusChecks
{
@@ -160,11 +166,18 @@ namespace Octokit
{
get
{
return String.Format(CultureInfo.InvariantCulture, "IncludeAdmins: {0} Strict: {1} Contexts: {2}", IncludeAdmins, Strict, Contexts == null ? "" : String.Join(",", Contexts));
return String.Format(CultureInfo.InvariantCulture,
"IncludeAdmins: {0} Strict: {1} Contexts: {2}",
IncludeAdmins,
Strict,
Contexts == null ? "" : String.Join(",", Contexts));
}
}
}
/// <summary>
/// Specifies people or teams allowed to push to the protected branch. Required status checks will still prevent these people from merging if the checks fail
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class ProtectedBranchRestrictions
{
@@ -190,7 +203,10 @@ namespace Octokit
{
get
{
return String.Format(CultureInfo.InvariantCulture, "Teams: {0} Users: {1}", Teams == null ? "" : String.Join(",", Teams), Users == null ? "" : String.Join(",", Users));
return String.Format(CultureInfo.InvariantCulture,
"Teams: {0} Users: {1}",
Teams == null ? "" : String.Join(",", Teams),
Users == null ? "" : String.Join(",", Users));
}
}
}