Status: Accepted
Owner: ----
Labels: Type-Defect Priority-Medium Target-2.7.2 bwic

New issue 1135 by robotframew...@gmail.com: Inconsistent handling of documentation paragraphs in log/report vs. libdoc
http://code.google.com/p/robotframework/issues/detail?id=1135

Currently libdoc combines lines that it considers part of same paragraph together, but docs in log/report this is not done. This means that the documentation rules are depended where the documentation is used.

We decided to fix this by combining lines together into paragraphs in html_format method and to wrap them into <p></p>. As a result we also need to handle lists and footnotes separately as otherwise they would end up into paragraphs unformatted. A separate issue will be submitted about that.

The change is backwards incompatible because the resulting docs change. In most cases the change should be only to better, but if someone has created special formatting expecting lines not to be combined things can go wrong. We decided to do the change in a minor release anyway because the current situation is buggy/inconsistent and the change shouldn't affect test execution results.

Reply via email to