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

Wrap long lines where possible in README #18

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
2 participants
@paultcochrane
Contributor

paultcochrane commented Mar 6, 2015

This is a purely cosmetic change, however most of the document seemed to be
written with a roughly 80 character width and thus to be consistent with
this style (and that it can be hard to read long lines on some terminals) it
could be a worthwhile improvement.

I can appreciate it if you don't wish to accept this PR; it is submitted in the hope that it helps :-)

Paul Cochrane
Wrap long lines where possible in README
This is a purely cosmetic change, however most of the document seemed to be
written with a roughly 80 character width and thus to be consistent with
this style (and that it can be hard to read long lines on some terminals) it
could be a worthwhile improvement.
@thaljef

This comment has been minimized.

Owner

thaljef commented Mar 11, 2015

README.md is generated by dzil, so I don't see the point in changing it directly.

Or have I completely misunderstood your intent?

@paultcochrane

This comment has been minimized.

Contributor

paultcochrane commented Mar 11, 2015

No, you're right, there is little point in changing it directly. Nevertheless, if it is automatically generated, it always begs the question "why is it in the repository?". My guess is that it's a good idea for a project in GitHub to have a README in the repo. In which case, one would probably like to have it checked in. This means it's also probably a good idea to update the file each time that dzil makes changes to the file. This is the reason I submitted PR #17: it keeps the README up to date with what dzil generates and stops the working copy from being in a dirty state (which is sort of a "huh?" moment for someone new to the project after a clone/test cycle), hence potentially confusing and something I'd like to avoid.

Would it be possible to merge PR #17 and then we can simply close this issue as "wontfix"?

@thaljef

This comment has been minimized.

Owner

thaljef commented Mar 11, 2015

My guess is that it's a good idea for a project in GitHub to have a README in the repo.

Exactly. My habit has been to re-commit the README whenever dzil decides to make it different (which is usually when I cut a release). The README up to date but it becomes out of date as soon as the POD changes or someone uses a different version of dzil.

Would it be possible to merge PR #17 and then we can simply close this issue as "wontfix"?

That sounds good to me.

@thaljef thaljef closed this Mar 11, 2015

@paultcochrane paultcochrane deleted the paultcochrane:pr/wrap_long_lines_in_readme branch Mar 14, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment