cancel
Showing results for 
Search instead for 
Did you mean: 
Read only

SAPUI5 API docs typography problem

csaba_molnar3
Explorer
901

The SAPUI5 API documentation has an annoying typographical problem which makes my head dizzy every time I try to read the docs.

The name of every event and method is placed so that it looks like it belongs to the parameter list of the previous event or method. This makes it very hard to see where is the boundary between two events.

The reason is that the name is closer to the parameter list of the previous event than the description of the given event. Also, the name is indented the same amount as the parameter list, so they appear to belong together.

Here is an example:

In my opinion, a typograpically (and logically) better way would be to change the margins and remove the indentation. Here is a suggestion I created with Chrome Inspector:

I would be grateful if you could change this and make reading the docs easier.

View Entire Topic
Margot
Product and Topic Expert
Product and Topic Expert

This is for sure a valuable feedback for the API Reference in the SAPUI5/OpenUI5 demo kit. But I don't think that the SAP Community is the right channel to address product feedback but this should be rather directed to the respective product team. As your feedback relates to both, SAPUI5 and OpenUI5, I agree with Boghyon that the best channel to provide your feedback is to open a GitHub Issue on the OpenUI5 repository, so this can be tracked properly, not only by the team but also by you and the community.

csaba_molnar3
Explorer
0 Likes

I've opened GitHub issue #3325: https://github.com/SAP/openui5/issues/3325 .