Skip to content

📝 Add docstrings to dev #8

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

Closed
coderabbitai wants to merge 1 commit into from
Closed

📝 Add docstrings to dev #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions RoundReports/Reporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace RoundReports
namespace RoundReports
{
using System;
using System.Collections;
Expand Down Expand Up @@ -513,7 +513,12 @@ private IEnumerator<float> SendReportInternal()
/// Huge method for handling the upload to Pastee and Discord, as well as the in-game broadcasts.
/// </summary>
/// <param name="iter">The current iteration of the method. Upload will be canceled if this reaches 10.</param>
/// <returns>Coroutine.</returns>
/// <summary>
/// Attempts to upload the round report to Pastee and send notifications to Discord and in-game broadcasts, retrying up to 10 times on failure.
/// </summary>
/// <param name="data">The report data to upload.</param>
/// <param name="iter">The current retry attempt count (default is 0).</param>
/// <returns>An enumerator for coroutine execution.</returns>
private IEnumerator<float> TryUpload(PasteEntry data, int iter = 0)
{
Log.Debug("Beginning report upload process.");
Expand Down Expand Up @@ -678,6 +683,11 @@ private IEnumerator<float> TryUpload(PasteEntry data, int iter = 0)
}
}

/// <summary>
/// Replaces placeholders in the input string with corresponding round report values, such as MVPs, kill counts, times, and report metadata.
/// </summary>
/// <param name="input">The string containing placeholders to be replaced with report data.</param>
/// <returns>The input string with all recognized placeholders replaced by their current values.</returns>
private string ProcessReportArgs(string input)
{
FinalStats final = GetStat<FinalStats>();
Expand Down
Loading