Discussion:
[deprecated list] svn commit
Anton Gladky
2009-05-19 15:20:28 UTC
Permalink
Hi All!
I have done small changes in one of the python scripts. May I make commit
this changes? If yes, what is a normal procedure for that?
In attachment you can find diff file.

Thank you

Best Regards / Mit freundlichen GrÌßen / С МаОлучшОЌО пПжелаМОяЌО

Anton Gladkyy
Václav Šmilauer
2009-05-19 16:33:33 UTC
Permalink
Janek will give you write access to the repository and you will be able
to commit (see svn instruction on the wiki). For this one, I will apply
the patch to my local copy and commit it the next time (it can take a
while, though, because of bigger changes being done). Vaclav



_______________________________________________
Mailing list: https://launchpad.net/~yade-users
Post to : yade-users-oU9gvf+***@public.gmane.org
Unsubscribe : https://launchpad.net/~yade-users
More help : https://help.launchpad.net/ListHelp
Anton Gladky
2009-05-19 17:51:48 UTC
Permalink
Ok, thank you.

Actually, I have not found an accurate instructions according to writing
style of YADE: what indents, how to write brackets, what is the maximal
string length etc.
Where can I get it?

Best Regards / Mit freundlichen GrÌßen / С МаОлучшОЌО пПжелаМОяЌО

Anton Gladkyy
Post by Václav Šmilauer
Janek will give you write access to the repository and you will be able
to commit (see svn instruction on the wiki). For this one, I will apply
the patch to my local copy and commit it the next time (it can take a
while, though, because of bigger changes being done). Vaclav
_______________________________________________
Mailing list: https://launchpad.net/~yade-users<https://launchpad.net/%7Eyade-users>
Unsubscribe : https://launchpad.net/~yade-users<https://launchpad.net/%7Eyade-users>
More help : https://help.launchpad.net/ListHelp
Václav Šmilauer
2009-05-19 18:22:58 UTC
Permalink
Post by Anton Gladky
Actually, I have not found an accurate instructions according to
writing style of YADE: what indents, how to write brackets, what is
the maximal string length etc.
Where can I get it?
Right here :-) Tabs to indent, otherwise no instructions. Everybody
would tell you about his/her own taste so there is no policy. (I prefer
spartan spacing, few linebreaks and longer lines as I have 24" panel,
for that matter).

Apart from this makeup style: IMPORTANT!! Always keep in mind that other
people will read your code: make sure you write comments and that
purpose of every class is clearly documented, preferrably both in the
header file and by providing a sample script on how to use it, for
example. The doxygen-style comments for all class members are also
desirable. If you are developing a bigger set of classes that cooperate
in some way, create a wiki page on that particular setup (like
http://yade.wikia.com/wiki/Speed_profiling_using_TimingInfo_and_TimingDeltas_classes) and put reference to the wiki page into sources or elsewhere.

Welcome on board.

Vaclav



_______________________________________________
Mailing list: https://launchpad.net/~yade-users
Post to : yade-users-oU9gvf+***@public.gmane.org
Unsubscribe : https://launchpad.net/~yade-users
More help : https://help.launchpad.net/ListHelp
Anton Gladky
2009-05-19 18:36:41 UTC
Permalink
Thank you for explanation.

But I think it would be good to have exact rules on style. Code must be in
order. Maybe, it is good to create some rules for new added code?

Best Regards / Mit freundlichen GrÌßen / С МаОлучшОЌО пПжелаМОяЌО

Anton Gladkyy
Post by Václav Šmilauer
Post by Anton Gladky
Actually, I have not found an accurate instructions according to
writing style of YADE: what indents, how to write brackets, what is
the maximal string length etc.
Where can I get it?
Right here :-) Tabs to indent, otherwise no instructions. Everybody
would tell you about his/her own taste so there is no policy. (I prefer
spartan spacing, few linebreaks and longer lines as I have 24" panel,
for that matter).
Apart from this makeup style: IMPORTANT!! Always keep in mind that other
people will read your code: make sure you write comments and that
purpose of every class is clearly documented, preferrably both in the
header file and by providing a sample script on how to use it, for
example. The doxygen-style comments for all class members are also
desirable. If you are developing a bigger set of classes that cooperate
in some way, create a wiki page on that particular setup (like
http://yade.wikia.com/wiki/Speed_profiling_using_TimingInfo_and_TimingDeltas_classes)
and put reference to the wiki page into sources or elsewhere.
Welcome on board.
Vaclav
_______________________________________________
Mailing list: https://launchpad.net/~yade-users<https://launchpad.net/%7Eyade-users>
Unsubscribe : https://launchpad.net/~yade-users<https://launchpad.net/%7Eyade-users>
More help : https://help.launchpad.net/ListHelp
Vincent Richefeu
2009-05-20 07:51:27 UTC
Permalink
Post by Anton Gladky
But I think it would be good to have exact rules on style. Code
must be in order. Maybe, it is good to create some rules for new
added code?
Vaclav is right. The questions, which concern only the personal taste
and do not affect the accuracy or clarity of the code, have no place
in a standard programming. There is no difference in readability
between:

void myFunction() { // ... }

and

void myFunction()
{
// ...
}

Nevertheless, this task (indentation, position of brackets...) can be
done automatically (for example with bcpp). So it is not important.

I think that the critical point is the naming convention. This
convention, without being too prescriptive, should exist (in fact
there are several in Yade!). In practice, each programmer is
responsible for his choice. For example: _if (face[i].belongBoundary)
_ and _if (bound[i] == 1)_ are quite similar but the second needs
explanation while the first is self-documented. Finally, the most
important is the design...

Vincent


_______________________________________________
Mailing list: https://launchpad.net/~yade-users
Post to : yade-users-oU9gvf+***@public.gmane.org
Unsubscribe : https://launchpad.net/~yade-users
More help : https://help.launchpad.net/ListHelp

Janek Kozicki
2009-05-25 15:34:50 UTC
Permalink
Václav Šmilauer said: (by the date of Tue, 19 May 2009 18:33:33 +0200)
Post by Václav Šmilauer
Janek will give you write access to the repository and you will be able
to commit (see svn instruction on the wiki). For this one, I will apply
the patch to my local copy and commit it the next time (it can take a
while, though, because of bigger changes being done). Vaclav
I've just returned from a conference and still quite busy. Vaclav
(and Bruno), you both have access permissions to add people to the
project. You can do it faster than me. Otherwise you will have to
wait a bit..
--
Janek Kozicki |

_______________________________________________
Mailing list: https://launchpad.net/~yade-users
Post to : yade-users-oU9gvf+***@public.gmane.org
Unsubscribe : https://launchpad.net/~yade-users
More help : https://help.launchpad.net/ListHelp
Loading...