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

Beautify license/module header comment #366

Closed
Tyriar opened this issue Nov 21, 2016 · 1 comment
Closed

Beautify license/module header comment #366

Tyriar opened this issue Nov 21, 2016 · 1 comment
Assignees
Labels
type/proposal A proposal that needs some discussion before proceeding
Milestone

Comments

@Tyriar
Copy link
Member

Tyriar commented Nov 21, 2016

@parisk how about we change this:

/**
 * xterm.js: xterm, in the browser
 * Copyright (c) 2016, SourceLair Private Company <www.sourcelair.com> (MIT License)
 */

/**
 * Generic utilities module. This module contains generic methods that can be helpful at
 * different parts of the code base.
 * @module xterm/utils/Generic
 */

To this:

/**
 * @license
 * xterm.js: xterm, in the browser
 * Copyright (c) 2016, SourceLair Private Company <www.sourcelair.com> (MIT License)
 *
 * @module xterm/utils/Generic
 * Generic utilities module. This module contains generic methods that can be helpful at
 * different parts of the code base.
 */

Looks a lot nicer imo.

@Tyriar Tyriar added the type/proposal A proposal that needs some discussion before proceeding label Nov 21, 2016
@parisk
Copy link
Contributor

parisk commented Nov 22, 2016

Yep, it is indeed. Assigning this to myself and adding this to the next milestone.

@parisk parisk self-assigned this Nov 22, 2016
@parisk parisk added this to the 2.2.0 milestone Nov 22, 2016
parisk referenced this issue Dec 1, 2016
Update documentation with cleaner license declaration
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/proposal A proposal that needs some discussion before proceeding
Projects
None yet
Development

No branches or pull requests

2 participants