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

Clean up source file headers (resolves #309, #310) #311

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

fnothaft
Copy link
Contributor

Makes two changes:

  • Attaches the ASF suggested license file header to all source files. This license header attributes copyright to the Regents of the University of California. Let me know if someone would like the copyright changed; I have this scripted, so it is a quick change. We'd probably want to add a NOTICES.txt file if making the copyright more specific.
  • Removes @author tags, as per discussion with @benedictpaten @hannes-ucsc on today's scrum.

@heuermh
Copy link
Member

heuermh commented Jun 20, 2016

+1

@@ -1,4 +1,5 @@
# Copyright (C) 2015 UCSC Computational Genomics Lab
#
# Copyright 2015–2016, Regents of the University of California
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we do this in Toil, too?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I generally prefer the Regents of the University of California copyright—esp. if you have contributors from multiple UCs—but I'm not picky.

@hannes-ucsc
Copy link
Contributor

Build fails with

pip2.7 install -e .
Obtaining file:///mnt/ephemeral/workspace/toil-scripts
    Complete output from command python setup.py egg_info:
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "/mnt/ephemeral/workspace/toil-scripts/setup.py", line 23, in <module>
        from version import version
      File "version.py", line 2
    SyntaxError: Non-ASCII character '\xe2' in file version.py on line 2, but no encoding declared; see http://python.org/dev/peps/pep-0263/ for details

@fnothaft
Copy link
Contributor Author

Build fails with

Hah! I got cocky and used an en dash instead of a hyphen in 2015–2016. Will fix.

fnothaft added 3 commits July 9, 2016 09:53
Adds the following text:

```
#
# Copyright 2015–2016, Regents of the University of California
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
```

As a header to all source files, as suggested as a best practice by
[the Apache Software Foundation](http://www.apache.org/licenses/LICENSE-2.0.html#apply).
@fnothaft fnothaft force-pushed the issues/309-310-clean-up-headers branch from 661d518 to 3c93ee7 Compare July 9, 2016 13:58
@fnothaft
Copy link
Contributor Author

fnothaft commented Jul 9, 2016

Rebased and addressed buld issue.

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

Successfully merging this pull request may close these issues.

4 participants