Skip to content
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

new standard comment header for all source files #1002

Closed
orbeckst opened this issue Sep 23, 2016 · 5 comments
Closed

new standard comment header for all source files #1002

orbeckst opened this issue Sep 23, 2016 · 5 comments
Assignees
Milestone

Comments

@orbeckst
Copy link
Member

We need to re-write the current standard comment header in our source files to better reflect the changes that have happened to the project since its early pre-2013 days.

The current header reads

# -*- Mode: python; tab-width: 4; indent-tabs-mode:nil; coding:utf-8 -*-
# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4
#
# MDAnalysis --- http://www.MDAnalysis.org
# Copyright (c) 2006-2015 Naveen Michaud-Agrawal, Elizabeth J. Denning, Oliver Beckstein
# and contributors (see AUTHORS for the full list)
#
# Released under the GNU Public Licence, v2 or any higher version
#
# Please cite your use of MDAnalysis in published work:
# N. Michaud-Agrawal, E. J. Denning, T. B. Woolf, and O. Beckstein.
# MDAnalysis: A Toolkit for the Analysis of Molecular Dynamics Simulations.
# J. Comput. Chem. 32 (2011), 2319--2327, doi:10.1002/jcc.21787
#

@tylerjereddy is tackling the citation changes (#993) in PR #1001. However, given the overwhelming contributions from a big developer team it is not appropriate anymore that Naveen's, Liz's and my own name are so prominently displayed.

I would suggest something along the lines of

# -*- Mode: python; tab-width: 4; indent-tabs-mode:nil; coding:utf-8 -*-
# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4
#
# MDAnalysis --- http://www.mdanalysis.org
# Copyright (c) 2006-2016 The MDAnalysis Development Team and contributors
# (see the file AUTHORS for the full list of names)
#
# Released under the GNU Public Licence, v2 or any higher version
#
# Please cite your use of MDAnalysis in published work:
#
# R. J. Gowers, M. Linke, J. Barnoud, T. J. E. Reddy, M. N. Melo, S. L. Seyler,
# D. L. Dotson, J. Domanski, S. Buchoux, I. M. Kenney, and O. Beckstein.
# MDAnalysis: A Python package for the rapid analysis of molecular dynamics
# simulations. In S. Benthall and S. Rostrup editors, Proceedings of the 15th
# Python in Science Conference, pages 102-109, Austin, TX, 2016. SciPy.
#
# N. Michaud-Agrawal, E. J. Denning, T. B. Woolf, and O. Beckstein.
# MDAnalysis: A Toolkit for the Analysis of Molecular Dynamics Simulations.
# J. Comput. Chem. 32 (2011), 2319--2327, doi:10.1002/jcc.21787
#

Any opinions, fellow @MDAnalysis/coredevs ?

@mnmelo
Copy link
Member

mnmelo commented Sep 24, 2016

I think this is perfect.

@tylerjereddy tylerjereddy self-assigned this Sep 26, 2016
@tylerjereddy
Copy link
Member

Looks like there aren't any objections so far?

@jbarnoud
Copy link
Contributor

I'm fine with it.

On 26-09-16 10:39, Tyler Reddy wrote:

Looks like there aren't any objections so far?


You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub
#1002 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ABUWugON7Gsk7nf374ok1jgiwFoLbh0Pks5qt4SkgaJpZM4KFVKT.

@kain88-de
Copy link
Member

Looks good to me too.

@orbeckst orbeckst removed the proposal label Sep 27, 2016
@richardjgowers
Copy link
Member

If we're doing this, we might also want to consider the dynamic author list here, and change it to be completely alphabetical.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants