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

neither use Windows newlines nor long lines in repository #338

Closed
lemzwerg opened this issue May 9, 2024 · 1 comment
Closed

neither use Windows newlines nor long lines in repository #338

lemzwerg opened this issue May 9, 2024 · 1 comment

Comments

@lemzwerg
Copy link

lemzwerg commented May 9, 2024

Please have a look at the current output of gitk.

image

There are two issues.

  1. The document string uses the Windows line ending format (i.e., \r\n) for no good reason. Please convert the whole repository to only use \n for newlines.
  2. Having such extremely long lines as for the document string makes it very hard to quickly compare changes with tools like gitk. Giving that JSON doesn't allow multi-line strings – for me this would have been a reason to not choose JSON at all – I ask to find solutions to avoid that, for example, by putting all those long strings into separate files as plain-text documents, inserting them into the final JSON structure using a post-processor like jq by calling make or something similar. [Note that I have zero experience with JSON; maybe jq isn't the right tool.]
@lemzwerg lemzwerg changed the title don't use Windows newlines in git repository neither use Windows newlines nor long lines in repository May 9, 2024
@adrianholovaty
Copy link
Contributor

Thanks for the suggestion. I've changed our docs tool to strip those Windows newline characters in c4e22a3.

For the long lines, I've opened issue #340 to keep track of that separately.

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

No branches or pull requests

2 participants