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.

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

Repairing xml comments #1846

Merged
merged 6 commits into from Aug 13, 2018

Conversation

Projects
None yet
4 participants
@StanleyGoldman
Contributor

StanleyGoldman commented Aug 8, 2018

Cleaning up xml comments

@StanleyGoldman StanleyGoldman added the WIP label Aug 8, 2018

@StanleyGoldman StanleyGoldman requested review from grokys and jcansdale Aug 8, 2018

@StanleyGoldman StanleyGoldman added Ready for Review and removed WIP labels Aug 9, 2018

@StanleyGoldman StanleyGoldman changed the title from [WIP] Repairing xml comments to Repairing xml comments Aug 9, 2018

@StanleyGoldman

Going back in time

@StanleyGoldman

Great Scott Marty! To the DeLorean!

@StanleyGoldman

I'm gonna be mayor of this town

@StanleyGoldman

I'm gonna be mayor of this town

@StanleyGoldman

I'm gonna be mayor of this town

@StanleyGoldman

I'm gonna be mayor of this town

@StanleyGoldman

I'm gonna be mayor of this town

@StanleyGoldman

Someday I'm gonna be mayor of this town

@StanleyGoldman

You want that when?

@@ -23,7 +23,7 @@ public interface IRepositoryCloneService
/// <param name="repositoryPath">The directory that will contain the repository directory.</param>
/// <param name="progress">
/// An object through which to report progress. This must be of type
/// <see cref="System.IProgress{Microsoft.VisualStudio.Shell.ServiceProgressData}"/>, but
/// System.IProgress&lt;Microsoft.VisualStudio.Shell.ServiceProgressData&gt;, but

This comment has been minimized.

@jcansdale

jcansdale Aug 9, 2018

Contributor

What happened here?

@jcansdale

jcansdale Aug 9, 2018

Contributor

What happened here?

This comment has been minimized.

@StanleyGoldman

StanleyGoldman Aug 9, 2018

Contributor

It was an incorrect <see> tag. The "cref" value could provide a link to documentation for System.IProgress{T} or Microsoft.VisualStudio.Shell.ServiceProgressData, but there is no link to documentation for System.IProgress{Microsoft.VisualStudio.Shell.ServiceProgressData}.

@StanleyGoldman

StanleyGoldman Aug 9, 2018

Contributor

It was an incorrect <see> tag. The "cref" value could provide a link to documentation for System.IProgress{T} or Microsoft.VisualStudio.Shell.ServiceProgressData, but there is no link to documentation for System.IProgress{Microsoft.VisualStudio.Shell.ServiceProgressData}.

Show outdated Hide outdated src/GitHub.App/Extensions/AkavacheExtensions.cs
@@ -336,6 +336,7 @@ public IVsTextView FindActiveView()
/// <param name="fromLines">The document we're navigating from.</param>
/// <param name="toLines">The document we're navigating to.</param>
/// <param name="line">The 0-based line we're navigating from.</param>
/// <param name="matchLinesAbove"></param>

This comment has been minimized.

@grokys

grokys Aug 10, 2018

Contributor

The number of lines to match.

@grokys

grokys Aug 10, 2018

Contributor

The number of lines to match.

This comment has been minimized.

@grokys

grokys Aug 10, 2018

Contributor

@jcansdale shouldn't the default for this parameter be MatchLinesAboveTarget instead of 0?

@grokys

grokys Aug 10, 2018

Contributor

@jcansdale shouldn't the default for this parameter be MatchLinesAboveTarget instead of 0?

/// <returns>A repository URL</returns>
GitHubContext FindContextFromWindowTitle(string windowTitle);
/// <summary>
/// Find a context from a browser window title.
/// </summary>
/// <param name="windowTitle">A browser window title.</param>
/// <param name="context"></param>

This comment has been minimized.

@grokys

grokys Aug 10, 2018

Contributor

The context? Not very descriptive. Do we need more info than this? @jcansdale?

@grokys

grokys Aug 10, 2018

Contributor

The context? Not very descriptive. Do we need more info than this? @jcansdale?

Show outdated Hide outdated src/GitHub.InlineReviews/ViewModels/PullRequestReviewCommentViewModel.cs

StanleyGoldman and others added some commits Aug 13, 2018

@grokys

grokys approved these changes Aug 13, 2018

@grokys grokys merged commit aeb7f79 into master Aug 13, 2018

2 checks passed

continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details

@grokys grokys deleted the xml-doc-comments branch Aug 13, 2018

@meaghanlewis meaghanlewis added this to the 2.5.5 milestone Aug 13, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment