SAP / openui5

OpenUI5 lets you build enterprise-ready web applications, responsive to all devices, running on almost any browser of your choice.
http://openui5.org
Apache License 2.0
2.95k stars 1.24k forks source link

Documentation doesn't render multiline <pre> code sample #2112

Closed gregorwolf closed 6 years ago

gregorwolf commented 6 years ago

OpenUI5 version: master

Browser/version (+device/version): Google Chrome is up to date Version 67.0.3396.99 (Official Build) (64-bit)

Any other tested browsers/devices: FAIL

URL (minimal example if possible): https://openui5nightly.hana.ondemand.com/#/api/sap.ui.table.TreeTable/controlProperties

Steps to reproduce the problem:

  1. For the property expandFirstLevel in the documentation linked above an Example is provided how to use the binding parameter numberOfExpandedLevels instead of this deprecated property.
  2. When I check the source in src/sap.ui.table/src/sap/ui/table/TreeTable.js I can see that this includes:
             * Example:
             * <pre>
             *   oTable.bindRows({
             *      path: "...",
             *      parameters: {
             *         numberOfExpandedLevels: 1
             *      }
             *   });
             * </pre>
             *
             * The value of the property 

What is the expected result? I would expect to see this example code also in the documentation.

What happens instead? The example code is not shown. Instead the text is "Example: The value of the property..."

Any other information?

screen shot 2018-07-14 at 17 30 19

Shtilianova commented 6 years ago

Hello @gregorwolf , Thank you for sharing this finding. I've created an internal incident 1880443613. The status of the issue will be updated here in GitHub. Regards, Diana

JumpNRun commented 6 years ago

Hi @gregorwolf ,

Thank you for reporting this issue. We have changed the documentation. In the next version it should be completely visible and much more readable than it is now.

Best regards, Alexander

gregorwolf commented 6 years ago

Hi @Shtilianova and @JumpNRun, so should it be visible in the nightly already? Or when will it apply to the documentation? Best regards Gregor

codeworrior commented 6 years ago

Submitted 2hrs ago -> next nightly (tomorrow)

gregorwolf commented 6 years ago

OK, I finally found the place where this improvement is visible: https://openui5nightly.hana.ondemand.com/#/api/sap.m.Tree/methods/expandToLevel Thanks.