Updates for "general" page in documentation #375
Conversation
|
Added a simple example for the Cheers, |
|
Hello, The commit concerning heading style, look at http://sphinx-doc.org/rest.html#sections |
LIBGIT2_VERSION was previously recorded as LIBGIT2_VER_VERSION which is incorrect. We also add basic explanations to all the constants so that the page is a little less bare. Perhaps this should be done as autodoc style comments in the code but I guess not.
To clarify the behaviour and usage.
|
Hi, I am sorry. I should not have tried to change the style. I've removed those commits. My confusion was that the page which describes that style, actually uses another one: http://sphinx-doc.org/_sources/rest.txt but it was unhelpful of me to try to randomly change things. I hope that the content contributions are useful. Cheers, |
It might seem like a really obvious point to make but without emphasizing it, it isn't completely clear. I would like to mention this in the Branch section as well for how to point a branch at another commit but I can't see how to smoothly slide it in.
I would have found this useful when trying to do reflog additions. It might not be massively complex but examples always help.
|
Hi, I've added a couple more examples and a spelling/typo fix. I hope they are acceptable. Cheers, |
|
Hi, Sorry for the delay. And thank you for contributing to the documentation, most |
|
Thanks for accepting it. Happy to help. I'm enjoying using pygit2 for a mini project at the moment. Cheers, |
Hi,
I am starting to use pygit2 for a little project. I've very grateful that it exists and would like to contribute a little bit. This isn't much but wanted to do a pull request to test the waters.
The first two commits are quite opinionated and really a matter of style. I am very happy if you ignore them.
The third commit is hopefully quite useful. It corrects an error in the constant name and provides additional information. I don't feel this is the most necessary documentation but I thought I'd give it a go.
Cheers,
Michael