Skip to content

patch: minor documentation fix.#3966

Merged
carlosmn merged 1 commit into
libgit2:masterfrom
vivaladav:documentation-fixes
Oct 16, 2016
Merged

patch: minor documentation fix.#3966
carlosmn merged 1 commit into
libgit2:masterfrom
vivaladav:documentation-fixes

Conversation

@vivaladav
Copy link
Copy Markdown
Contributor

Fix @return description of git_patch_num_lines_in_hunk.

Issue #3965

Fix @return description of git_patch_num_lines_in_hunk.
@staticfloat
Copy link
Copy Markdown
Contributor

As a gentle reminder, please try to quote any macro names with backticks, e.g. @return, as we don't want to bother github users by accidentally mentioning them in issues like this.

This change doesn't match what is shown in the official libgit2 documentation, what do you think about applying this change to libgit2 upstream?

@vivaladav
Copy link
Copy Markdown
Contributor Author

As a gentle reminder, please try to quote any macro names with backticks

I will do, sorry about that. I created my GitHub account last night and this is my first contribution. I honestly didn't think about it.

This change doesn't match what is shown in the official libgit2 documentation

The documentation is wrong, as you can see from the linked issue. That's the reason for the fix.

@carlosmn
Copy link
Copy Markdown
Member

Thanks!

@ethomson
Copy link
Copy Markdown
Member

This change doesn't match what is shown in the official libgit2 documentation, what do you think about applying this change to libgit2 upstream?

To clarify: this is a change to the documentation. Our docs are automatically generated from the public headers, so this will update them.

@ethomson
Copy link
Copy Markdown
Member

And thanks again @vivaladev ✨ ! Welcome to the libgit2 project! 😀

@staticfloat
Copy link
Copy Markdown
Contributor

My goodness, I was so confused. I thought I was in a completely different repository. Sorry for the noise! ;)

@vivaladav
Copy link
Copy Markdown
Contributor Author

Thank you @ethomson

I noticed this "bug" while trying to figure out why something doesn't work as expected with some patch functions. Hopefully I will be able to contribute more as soon as I get my head around it (I will open an issue at least).

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