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

Correct contradictory documentation #53

Closed
wants to merge 1 commit into from

Conversation

tommygnr
Copy link
Contributor

Line 51 of the Readme disagrees with line 71. Per the source code line 71 is correct

@tommygnr
Copy link
Contributor Author

On further reflection I'm not sure I have this the right way around. I think the first question is what should the textract do. Should it preserve line breaks by default or not?

@tommygnr tommygnr changed the title Correct contradictory documentation documentation Correct contradictory documentation Aug 11, 2015
The documentation around the preserveLineBreaks option is contradictory. Line 51 disagrees with line 71. Per the [source code](https://github.com/dbashford/textract/blob/5cc50dd9c3a4f76680b3737170645598b401ec64/lib/cli.js#L14) line 71 is correct
@dbashford
Copy link
Owner

Few things happening here. The CLI has always been an afterthought (hence not having a test in place ensuring it worked). It's something easy to pull off and it lets folks quickly try out the library. I've always intended to core use of the library to be in processing things via a node app.

Because of that, when I introduced the CLI option, readability was more important to me. It was a chance for someone with two commands (npm install, textract foo) to see that it can do as advertised. With readability the key thing, the CLI's line breaks were left on by default.

I'd like to keep it that way. But you point out the documentation isn't clear there, so I'll remedy that.

@dbashford dbashford closed this Aug 11, 2015
@dbashford
Copy link
Owner

And by not clear I mean wrong= p

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

Successfully merging this pull request may close these issues.

2 participants