Why does a comma insert a line break in a comment?

Question

I like to include capital letters and punctuation in my comments. But when I put a comma into a Mathematica comment of the (* ... *) type, it usually causes the comment line to break, with a new line starting after the comma. I find this both annoying and time-consuming. Is this behavior desirable in some context? More importantly, can I turn it off?

Here is an example. Copy the two lines below and paste them into a new, empty Mathematica document.

(* Complement of dihedral angles of a regular *)
(* icosahedron in degrees. *)

After the above text has been pasted in, insert a comma after the word "icosahedron". In my setup, this breaks the line in two.

I am using Mathematica 10.0.2.0 under the Mavericks version of Mac OS. I will be happy to provide more details of my setup if needed, but as far as I know, there is nothing special in this installation. I have also seen this happen on other versions of Mathematica.

Answer 1

I can not really explain why this is happening, but I can offer you 3 solutions that will stop this.

Solution 1

You can manually turn off automatic linepraking in the option inspector:

Solution 2

Another aproach to prevent this is to use a \[NonBreakingSpace] right after the comma character: ",\[NonBreakingSpace]". Type it in with EscnbsEsc.

I would prefer the second solution, because generally turning of the linebreaking might not be such a good idea.

Solution 3

Since typing in EscnbsEsc is indeed not very practical, you can use this setting for all input cells:

LinebreakAdjustments->{0.5, 10, 100, 1, 0.5}

From the docs of LinebreakAdjustments:

The default setting LinebreakAdjustments->{0.85, 2, 12, 1, 1} represents an empirical choice that works well for most Mathematica input. An alternative setting that gives good results for program code is LinebreakAdjustments->{0.5, 10, 100, 1, 0.5}.

It can be set globally in the Option Inspector right below "LineBreakWithin", but I would suggest to edit the default stylesheet and add this option for all input cells.

How to: Edit a Stylesheet (see last edit for quick solution)

Open a fresh notebook. Go to Format -> Edit Stylesheet...

Add a new cell to the stylesheet notebook. Chose Cell -> Show Expression, replace the cell-content with:

Cell[StyleData["Input"],
LinebreakAdjustments->{0.5, 10, 100, 1, 0.5}]

This will add the modificated linebreak adjustment to the default options of any input cells.

Go to Install Stylesheet... and type in an instal name e.g. NonBreakingDefault.

From now on you can chose this stylesheet from the menu Format -> StyleSheet. You can also set this stylesheet as the default stylesheet wich is loaded, when you open a new notebook. You can do this also in the option inspector: Global Options -> File Locations -> DefaultStyleDefinitions. Chose the stylesheet. You will find it in FileNameJoin[{$UserBaseDirectory, "SystemFiles", "FrontEnd", "StyleSheets"}]

EDIT2:

This code will automatically create the needed stylesheet for you:

CreateDocument[
Notebook[{Cell[StyleData[StyleDefinitions -> "Default.nb"]], 
Cell[StyleData["Input"], 
LinebreakAdjustments -> {0.5`, 10, 100, 1, 0.5`}]}, 
StyleDefinitions -> "PrivateStylesheetFormatting.nb", 
WindowTitle -> "NonBreakingDefault"]]

Just evaluate the cell and after it opens, you can instal the stylesheet.

Answer 2

Working on figuring out cause, but here's an example:

Gets even stranger:

Turning off word-wrap seems to remedy these... as does using (*" for start of a comment.

Answer 3

@sacratus has provided solutions for this. So I'll just provide my version of explanation here.

I guess the reason for this behavior is that the commented part is actually treated as code. In other word, the (**) comment is intended for commenting out code, not for arbitrary text.

Hence a "comma" is not a usual textual comma, it still is the separator between list elements. And the text before and after comma is treated as list element. Hence line is breaked for increased clarity when editing (potentially) long list elements. Note that the behavior is the same if you remove the (**) comment symbols, like so:

As you may have seen, if the part of line after the comma can fit in the original line, it will go eventually back to where it was after you hit <Enter> at the end of the line (which signifies your editing of the list element is finished). See the following screenshot:

This is exactly the same behavior when you editing a list consisting of several long elements.

By the way, I think Wolfram may want arbitrary text comments to be put into separate text cells, as part of notebook document flow that they imagined.

Answer 4

A much easier solution is to simply wrap your comment in parentheses. Use:

(*( Text; Text, Text. )*)

Instead of:

(* Text; Text, Text *)