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.

Sign up for GitHub

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

Jump to bottom

Style: line length #126

Closed
cjerdonek opened this issue Apr 24, 2015 · 5 comments
Closed

Style: line length #126

cjerdonek opened this issue Apr 24, 2015 · 5 comments
Assignees
@cjerdonek
Labels
documentation enhancement
Milestone
Version 5.0 Docum...

Comments

@cjerdonek
Copy link
Contributor

I wanted to suggest some sort of non-strict line length guideline to apply to all of our files (xml, html, md). The main reason is to make diffs more useful (e.g. those that appear in GitHub). I noticed that some lines in the HTML and markdown seem to run very long (e.g. 200+ characters). Maybe it could be phrased as a goal of 80 characters, but longer is fine whenever it aids readability.
@cjerdonek
Copy link
Contributor Author

This wouldn't apply to sample feeds, of course (e.g. XML and CSV).

@jdmgoogle
Copy link
Contributor

Given the verbosity of XML and HTML, I propose a 100-character suggested line limit. The current HEAD for vip5 has a vip_spec.xml of 662 lines. Of those:

  • 111 are 81+ characters long; and
  • 22 are 100+ characters long.

@cjerdonek
Copy link
Contributor Author

100 as the suggestion seems fine to me. I can write up the PR.

@cjerdonek cjerdonek added this to the Up for Debate milestone Apr 27, 2015
@jungshadow jungshadow modified the milestones: Version 5.0, Up for Debate Apr 29, 2015
cjerdonek added a commit that referenced this issue Apr 29, 2015
@cjerdonek
Address issue #126: add line length to style guide.
921620c
@cjerdonek cjerdonek mentioned this issue Apr 29, 2015
Merged
@cjerdonek
Copy link
Contributor Author

Created PR #128 for this.

cjerdonek added a commit that referenced this issue Apr 29, 2015
@cjerdonek
Merge pull request #128 from votinginfoproject/feature/issue-126-styl…
51ec59a 
…e-line-length

Address issue #126: add line length to style guide.
@cjerdonek
Copy link
Contributor Author

Closed by PR #128.

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

@cjerdonek cjerdonek

Labels
documentation enhancement
Projects
None yet
Milestone
Version 5.0 Documentation
Development

No branches or pull requests
3 participants
@jungshadow @cjerdonek @jdmgoogle