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

Cleanup API in README #127

Merged
merged 3 commits into from
Mar 24, 2016
Merged

Cleanup API in README #127

merged 3 commits into from
Mar 24, 2016

Conversation

steelbrain
Copy link
Owner

Just like the title says

}
export function exec(command: String, args: Array<string> = [], options: Object)
export function execNode(filePath: String, args: Array<string> = [], options: Object)
export function parse(data: String, regex: String, options: Object = {baseReduction: 1, flags: ""})
Copy link
Collaborator

Choose a reason for hiding this comment

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

baseReduction isn't used in the code anywhere, where did this come from?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also shouldn't this show that by default (forced) the g flag is used?

Copy link
Owner Author

Choose a reason for hiding this comment

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

It was used to convert Line 5 to Line 4 to make it Atom's 0-based range. Done

@steelbrain steelbrain force-pushed the steelbrain/cleanup-readme branch from fae6050 to 3784a6a Compare March 24, 2016 19:03
static tempFile<T>(fileName:String, fileContents:String, Callback:Function<T>):Promise<T>
static tempFiles<T>(filesNames:Array<{name: String, contents: String}>, callback:Function<T>):Promise<T>
}
export function exec(command: String, args: Array<string> = [], options: Object)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should the return type be specified on these functions that return something?

Copy link
Owner Author

Choose a reason for hiding this comment

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

Added return types for exec, execNode and parse

@steelbrain steelbrain force-pushed the steelbrain/cleanup-readme branch from 3784a6a to 297eef6 Compare March 24, 2016 19:05
@steelbrain
Copy link
Owner Author

Note: CI build is failing because of babel/babel-eslint#267

export function execNode(filePath: String, args: Array<string> = [], options: Object): Promise
export function parse(data: String, regex: String, options: Object = {flags: 'g'}): Array<Linter$Message>
export function rangeFromLineNumber(textEditor: TextEditor, lineNumber: Number = 0, colStart: Number = <firstTextColumn>):Array
export function find(directory:String, names: String | Array<string>): ?String
Copy link
Collaborator

Choose a reason for hiding this comment

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

directory:String -> directory: String

Copy link
Owner Author

Choose a reason for hiding this comment

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

There should be a linter that does that, I had previously just copy/pasted, I'll tweak them all now

@steelbrain steelbrain force-pushed the steelbrain/cleanup-readme branch from 297eef6 to 0027cb5 Compare March 24, 2016 19:13
@Arcanemagus
Copy link
Collaborator

I think that last batch of comments is the last thing I see.

@steelbrain
Copy link
Owner Author

All comments taken care of

@steelbrain steelbrain force-pushed the steelbrain/cleanup-readme branch from 375989e to 0027cb5 Compare March 24, 2016 19:35
@steelbrain steelbrain merged commit b7b74fe into master Mar 24, 2016
@steelbrain steelbrain deleted the steelbrain/cleanup-readme branch March 24, 2016 19:55
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.

2 participants