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

Documentation #253

Merged
merged 4 commits into from
Dec 8, 2013
Merged

Documentation #253

merged 4 commits into from
Dec 8, 2013

Conversation

pmacn
Copy link

@pmacn pmacn commented Dec 3, 2013

Documentation for Issue #196

There's more coming once I cherry pick them into meaningful commits and
resolve a slight issue with my local repo, fat-fingered it.

Peter MacNaughton added 3 commits December 2, 2013 22:08
Modified existing comments in IGitDatabaseClient, IMiscellaneousClient and
ITeamsClient. Hopefully for valid reasons.
@@ -2,6 +2,10 @@
{
public class ActivitiesClient : ApiClient, IActivitiesClient
{
/// <summary>
/// Instatiate a new GitHub Activities API client.
Copy link
Contributor

Choose a reason for hiding this comment

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

What does "instatiate" mean? :trollface:

I believe you typo'd this. Should be "Instantiate"

Copy link
Contributor

Choose a reason for hiding this comment

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

There's a few other typos like this. I won't comment them all. 😄

@haacked
Copy link
Contributor

haacked commented Dec 4, 2013

This is a great start! Thank you so much for this.

Also expanded the IGitDatabaseClient summary
@pmacn
Copy link
Author

pmacn commented Dec 6, 2013

I could have sworn I left a comment on this, I guess not. My imaginary comment went something like this.

What does "instatiate" mean? :trollface:

Wow, that's all.. wow. Will fix.

Hmm, this should be more descriptive. Maybe, "A client for GitHub's Git Database API that lets you update raw Git objects."

I'll expand this to "A client for GitHub's Git Database API" for now and maybe add a second descriptive line to all of these down the line.

@haacked
Copy link
Contributor

haacked commented Dec 6, 2013

👍

@shiftkey
Copy link
Member

shiftkey commented Dec 6, 2013

I'm happy to merge this in and keep refining it over time. Any objections @haacked?

@shiftkey
Copy link
Member

shiftkey commented Dec 8, 2013

Thanks @pmacn for helping with this.

1291

shiftkey added a commit that referenced this pull request Dec 8, 2013
@shiftkey shiftkey merged commit 60def6e into octokit:master Dec 8, 2013
@pmacn pmacn deleted the feature/documentation branch December 8, 2013 18:35
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.

3 participants