gp1313 / iep

Automatically exported from code.google.com/p/iep
0 stars 0 forks source link

Interactive help "smart format" not very smart! #187

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
Since it ignores line breaks one long string is shown and that's hard to read; 
there should be some distinction between sentences where line breaks where in 
order to improve readability.
Some easy options to experiment with to slightly improve readability would be 
a) to bolden the last character in a line of text - assuming a punctuation mark 
- or to added a bold period to the end of a line where no punctuation mark 
existed (just in case); b) to bolden the first character (not including spaces) 
after a line break; c) to add some kind of a non-intrusive separator such as a 
small section sign (§) that's easy to look for, yet easy to ignore.

Original issue reported on code.google.com by zaha...@gmail.com on 7 Mar 2013 at 9:39

GoogleCodeExporter commented 8 years ago
The problem is that the best way to display these docs depends a lot on how the 
author of the docstring wrote them.

Usually newlines should be ignored, and an empty line means a new paragraph. 
But this
is not always the case. In these cases smart format should be turned off.

But yeah, perhaps it can be made smarter :)

Original comment by almar.klein@gmail.com on 8 Mar 2013 at 12:19

GoogleCodeExporter commented 8 years ago
As part of migrating our code repositories from Googlecode
to Bitbucket, all IEP issues are now tracked at 
https://bitbucket.org/iep-project/iep/issues

To view this issue, use this link (with X replaced by the issue number):
https://bitbucket.org/iep-project/iep/issue/X

Issues on Bitbucket can be created by anyone. Commenting on issues requires 
login via Bitbucket, Google, Twitter or Github.

Original comment by almar.klein@gmail.com on 11 Jun 2013 at 2:40