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

Mans: Keep text within 78-char ruler #2783

Closed
RichardLitt opened this issue Jun 1, 2016 · 7 comments
Closed

Mans: Keep text within 78-char ruler #2783

RichardLitt opened this issue Jun 1, 2016 · 7 comments
Labels
help wanted Seeking public contribution on this issue need/community-input Needs input from the wider community topic/docs-ipfs Topic docs-ipfs
Milestone

Comments

@RichardLitt
Copy link
Member

I think we should keep the text for the descriptions wrapped in under the 78-char ruler. Here is an example where that doesn't happen, on my terminal:

screen shot 2016-06-01 at 4 48 34 pm

Even if this is a ridiculous cultural remnant of IBM's punchcard days, it may still be worth doing to conform to the industry standard.

I've gone through and manually PRed the descriptions to be wrapped (See #2782, #2780, #2779), but there are still the cases of the options and some of the examples. Should we manually wrap options? And Synopses? If so, how?

@RichardLitt RichardLitt added topic/docs-ipfs Topic docs-ipfs need/community-input Needs input from the wider community labels Jun 1, 2016
@whyrusleeping whyrusleeping added the status/deferred Conscious decision to pause or backlog label Sep 14, 2016
@whyrusleeping
Copy link
Member

whyrusleeping commented Mar 6, 2017

We should have a test that we can manually run to verify all our helptext fits within this limit. I think its a good idea to try and keep the 78 (but really 80) character limit

  • Add a test to check width of helptexts

@whyrusleeping whyrusleeping added this to the Ipfs 0.4.7 milestone Mar 6, 2017
@whyrusleeping whyrusleeping modified the milestones: Ipfs 0.4.8, Ipfs 0.4.7 Mar 10, 2017
@whyrusleeping
Copy link
Member

whyrusleeping commented Mar 10, 2017

We've got a test for this now. Next up is trying to make it pass.

To run the test:

make test/sharness/t0010-basic-commands.sh

~Kubuxu changed the command

@whyrusleeping
Copy link
Member

I'm assuming that since the test is merged to master, and things are passing, that this has been resolved

@whyrusleeping whyrusleeping removed the status/deferred Conscious decision to pause or backlog label Mar 24, 2017
@Kubuxu
Copy link
Member

Kubuxu commented Mar 24, 2017

Tests are not passing, they are marked as failed.

@Kubuxu Kubuxu reopened this Mar 24, 2017
@whyrusleeping whyrusleeping modified the milestones: Ipfs 0.4.9, Ipfs 0.4.8 Mar 25, 2017
@whyrusleeping whyrusleeping added the help wanted Seeking public contribution on this issue label May 2, 2017
@whyrusleeping
Copy link
Member

If any contributor is looking for something easy to get started with this, one would be great

@whyrusleeping whyrusleeping modified the milestones: Ipfs 0.4.10, Ipfs 0.4.9 May 2, 2017
@magik6k magik6k modified the milestones: Ipfs 0.4.10, Ipfs 0.4.11 Jul 28, 2017
@devedge
Copy link
Contributor

devedge commented Aug 1, 2017

I'm interested in taking this, are there any specific style guidelines I should adhere to when wrapping the text?

devedge added a commit to devedge/go-ipfs that referenced this issue Aug 5, 2017
Make all help command descriptions wrap under 80 characters, as per issue ipfs#2783

License: MIT
Signed-off-by: Richard Pajerski <devedge@outlook.com>
@magik6k
Copy link
Member

magik6k commented Nov 2, 2017

Done in #4121

@magik6k magik6k closed this as completed Nov 2, 2017
@magik6k magik6k modified the milestones: Ipfs 0.4.11, Ipfs 0.4.12 Nov 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Seeking public contribution on this issue need/community-input Needs input from the wider community topic/docs-ipfs Topic docs-ipfs
Projects
None yet
Development

No branches or pull requests

5 participants