-
-
Notifications
You must be signed in to change notification settings - Fork 385
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
Coding Guidelines #238
Comments
I wrote something about coding guidelines in the wiki. See Guidelines and Conding-Conventions. These are some proposals which @jdavid, @esc and I discussed at git-merge. |
I edited the wiki a little bit to make it a little clearer. I think the Guidelines text needs some improvement. In the High Level API bit, I didn't quite get the last two bullets. If there's any way to say it in a clearer way I think it'd be very helpful for newcomers. |
I refactored the text a litle bit. Hopefully it's clearer now. |
It does help! Thanks! |
A quick note. For the C coding style, we could simplify by just saying we follow PEP7 Regarding the Python coding style I would like to make some exceptions to PEP8, I will comment on it later. (By the way, if you run pep8 on the standard library you get tons of errors.) |
True, but the standard library is not a great example in Python 2.7 (in Just look at modules like Queue (a module with camel-cased naming). Cheers, Bernardo Heynemann On Mon, May 20, 2013 at 11:35 AM, J. David Ibáñez
|
Regarding coding style now pep8 does not produce any error message. There are few things I do not like about PEP8, but the one that bothers me most is to use only one blank line to separate methods. I find two blanks lines to be more readable. So I have configured pep8 to ignore this PEP8 rule, and updated the wiki accordingly. If somebody disagrees just speak. |
I added a "valgrind memleak check"-note to the Guidelines. |
I think we should refactor the pygit2 code base a bit. There are tons of warning messages for pygit2 in valgrind relating to uninitialized variables. See the log this: valgrind.log. Additionally there is a verbose output for pygit2 with cpychecker (mainly missing error handling): cpychecker.log |
@cholin do you fix it 😃 ? |
Can this issue be closed? It is very confusing when trying to understand if guidelines are set or not. |
Probably. |
@jdavid , can you close the issue? |
As asked by @jdavid I'd like to start a thread here on the coding guidelines adopted by pygit2 as I got a little confused when submitting my pull request.
Thanks a lot for the help in getting my code merged.
The text was updated successfully, but these errors were encountered: