-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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
Comments
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
|
We've got a test for this now. Next up is trying to make it pass. To run the test:
~Kubuxu changed the command |
I'm assuming that since the test is merged to master, and things are passing, that this has been resolved |
Tests are not passing, they are marked as failed. |
If any contributor is looking for something easy to get started with this, one would be great |
I'm interested in taking this, are there any specific style guidelines I should adhere to when wrapping the text? |
Make all help command descriptions wrap under 80 characters, as per issue ipfs#2783 License: MIT Signed-off-by: Richard Pajerski <devedge@outlook.com>
Done in #4121 |
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:
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?
The text was updated successfully, but these errors were encountered: