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.

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

Add repositoryId overloads to methods on I(Observable)WatchedClient #1372

Merged

Conversation

alexander-efremov
Copy link
Contributor

As part of my work on #1120 I've added new overloads on I(Observable)WatchedClient to get access by repository id.

  • Update XML documentation of interface methods of clients (also synchronize XML docs of IWatchedClient and IObservableWatchedClient).

    There is some divergence between XML documentation of methods in IWatchedClient and IObservableWatchedClient. So I've decided
    to sync XML documentation of these classes during my work on Add support for interacting with repositories by id. #1120.

  • Add overloads to IWatchedClient.

    Just add overloads of existing methods that use repositoryId to work with repo.

  • Add overloads to IObservableWatchedClient.

    Just add overloads of existing methods that use repositoryId to work with repo.

  • Add unit tests.

    I've added new unit tests that use repositoryId to work with repo that is just a full copy of existing tests that use (owner, name) key.
    Also I've found out that not all methods are covered by tests and added them for new and for old methods.

  • Add integration tests.

    I've added new integration tests that use repositoryId to work with repo that is just a full copy of existing tests that use (owner, name) key.
    Also I've found out that not all methods are covered by tests and added them for new and for old methods.

/cc @shiftkey, @ryangribble

@ryangribble ryangribble added this to the RepositoryId Support milestone Jun 13, 2016
@alexander-efremov
Copy link
Contributor Author

@ryangribble please rerun Travis whenever possible 👍

@alexander-efremov
Copy link
Contributor Author

I've cleared tags here.

@@ -11,24 +17,41 @@ public interface IObservableWatchedClient
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated</exception>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s watching the passed repository</returns>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we removing the return description? If that's a direction we want to take, might as well remove the entire /// <returns></returns> line.

Copy link
Contributor Author

@alexander-efremov alexander-efremov Jun 23, 2016

Choose a reason for hiding this comment

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

@haacked We've discussed this here with @shiftkey. And yep, I'll remove /// <returns></returns> in next commits when other things will be reviewed 👍

@alexander-efremov
Copy link
Contributor Author

@shiftkey I've removed tags here.

@shiftkey shiftkey merged commit 082c615 into octokit:master Jul 6, 2016
@alexander-efremov alexander-efremov deleted the add-repo-id-watched-client branch July 6, 2016 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants