(Sorry - previous email was sent by accident)
On the topic of documentation, here's what I've got so far:
https://gist.github.com/baoilleach/d9f02fb906e70277f6b4721d63d68b59
I still need to add descriptions of how to specify testfiles, and handle
exceptions. Apart from that, anything missing or could be explained better?
- Noel
On 25 April 2018 at 07:17, Noel O'Boyle <baoille...@gmail.com> wrote:
> On the topic of documentation, here's what I've got so far. Anything
> missing?
>
> On 17 April 2018 at 06:58, David van der Spoel <sp...@xray.bmc.uu.se>
> wrote:
>
>> Den 2018-04-17 kl. 07:51, skrev Noel O'Boyle:
>>
>>> To avoid digressing, absolutely we would like to do this and have the
>>> technical means to enforce...once we reduce the warnings. I did a certain
>>> amount already this year. Once a particular type of warning is eliminated
>>> we can add it as a requirement using gcc's treat warnings as errors. But
>>> we're not there yet. Like Geoff says, we encourage people to help.
>>>
>>> If there's some other way this can be enforced on a patch by patch basis
>>> (e.g. controlling for an increase in warnings), I'd be interested to hear.
>>> Maybe you can point me to the relevant person over at Gromacs.
>>>
>>> The GROMACS system uses gerrit https://www.gerritcodereview.com/ for
>> reviewing code and jenkins for building in the background
>> https://jenkins.io/index.html
>>
>> As far as I understand this is not entirely trivial to maintain, but once
>> it is set up it works nicely.
>>
>>
>> - Noel
>>>
>>>
>>> On Tue, 17 Apr 2018, 05:18 David van der Spoel, <sp...@xray.bmc.uu.se
>>> <mailto:sp...@xray.bmc.uu.se>> wrote:
>>>
>>> Den 2018-04-16 kl. 22:46, skrev Dominik 'Rathann' Mierzejewski:
>>> > On Monday, 16 April 2018 at 20:20, David van der Spoel wrote:
>>> >> Den 2018-04-16 kl. 17:36, skrev David Koes:
>>> >>> I didn't chime in since I thought it was obviously a good idea.
>>> >>> However, I strongly agree that the process of creating a test
>>> case needs
>>> >>> to be as simple and documented as possible. I had a test case
>>> with my
>>> >>> last pull request, but it required a fair amount of poking
>>> around to
>>> >>> figure out how to best implement it (and this experience
>>> prompted the
>>> >>> GSoC project).
>>> >>>
>>> >>> Also, test cases may not make sense for some pull requests (e.g.
>>> >>> documentation).
>>> >>
>>> >> Agree tests are a must.
>>> >>
>>> >> How about making warning-free code a must?
>>> >
>>> > Warning-free under which compiler (and version)? GCC adds new
>>> warnings
>>> > in every release.
>>> Under all compilers. Obviously we can only fix the warnings we are
>>> getting.
>>>
>>> We have this policy in http://www.gromacs.org and it is enforced
>>> automatically by the robot that verifies patches. No patches that
>>> produce warnings on any platform (Linux, Mac, Windows) will be
>>> accepted.
>>>
>>> >
>>> > Regards,
>>> > Dominik
>>> >
>>>
>>>
>>> -- David van der Spoel, Ph.D., Professor of Biology
>>> Head of Department, Cell & Molecular Biology, Uppsala University.
>>> Box 596, SE-75124 Uppsala, Sweden. Phone: +46184714205.
>>> http://www.icm.uu.se
>>>
>>> ------------------------------------------------------------
>>> ------------------
>>> Check out the vibrant tech community on one of the world's most
>>> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
>>> _______________________________________________
>>> OpenBabel-Devel mailing list
>>> OpenBabel-Devel@lists.sourceforge.net
>>> <mailto:OpenBabel-Devel@lists.sourceforge.net>
>>> https://lists.sourceforge.net/lists/listinfo/openbabel-devel
>>> <https://lists.sourceforge.net/lists/listinfo/openbabel-devel>
>>>
>>>
>>
>> --
>> David van der Spoel, Ph.D., Professor of Biology
>> Head of Department, Cell & Molecular Biology, Uppsala University.
>> Box 596, SE-75124 Uppsala, Sweden. Phone: +46184714205.
>> http://www.icm.uu.se
>>
>> ------------------------------------------------------------
>> ------------------
>> Check out the vibrant tech community on one of the world's most
>> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
>> _______________________________________________
>> OpenBabel-Devel mailing list
>> OpenBabel-Devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/openbabel-devel
>>
>
>
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
OpenBabel-Devel mailing list
OpenBabel-Devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openbabel-devel
