Skip to content

Normalized line endings across all articles and ported @lends documentation #12

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

Closed
wants to merge 5 commits into from

Conversation

peitschie
Copy link
Contributor

I only intended to port the @Lends tag documentation across as I was discovering what this tag was doing. However, I develop on Windows, and found as soon as I tried to run Jake that most of the files were showing up as modified due to the inconsistent line endings. I am happy to re-work or modify as requested.

@hegemonic
Copy link
Contributor

@peitschie, thanks for the patch!

I think git has some built-in tools to deal with the line-ending issue, and I'd like to use those if possible so the change history doesn't get confusing. I'll look into this within the next day or so. If this doesn't pan out, I think normalizing the line endings in the Jakefile is an excellent solution.

Also, one minor comment: We're now calling it "JSDoc" (note the capitalization) rather than "JsDoc Toolkit." I'm happy to fix this after merging your commit, but I thought I'd let you know for future reference.

@peitschie
Copy link
Contributor Author

@hegemonic,

I've updated the JSDoc references as requested.

You are right about git (https://help.github.com/articles/dealing-with-line-endings). I actually toyed with that first, then saw the line endings were all ready being manually stripped by that existing function, so figured "when in Rome..." :). Let me know if you want me to revert the line-ending changes.

Thanks for all your work :).

Philip

@hegemonic
Copy link
Contributor

Thanks for updating the JSDoc references!

Alas, I wasn't able to get to this today, and I'm about to head out of town for a few days. I'll take another look when I return.

@hegemonic
Copy link
Contributor

I finally merged this in by cherry-picking the new content, then setting up a .gitattributes file to help with the line endings. I don't know whether this is better than normalizing the line endings in the Jakefile, but it made me feel a little better to do things the official git way. ;)

Thanks again for your contribution!

@hegemonic hegemonic closed this Mar 6, 2013
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