Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs typography problem #3325

Open
mocsa opened this issue Aug 23, 2021 · 4 comments
Open

API docs typography problem #3325

mocsa opened this issue Aug 23, 2021 · 4 comments

Comments

@mocsa
Copy link

mocsa commented Aug 23, 2021

I've already reported here the same problem but I was asked to post it here, instead.

The SAPUI5 and OpenUI5 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:

bad-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:

good-example

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

@mocsa
Copy link
Author

mocsa commented Aug 23, 2021

The same problem also applies to section titles (Aggregations, Events, Methods) and subtitles (Summary).

@IlianaB IlianaB self-assigned this Aug 23, 2021
@IlianaB
Copy link
Member

IlianaB commented Aug 23, 2021

Hello @mocsa ,

Thank you for sharing this finding. I've created an internal incident 2180367090 for this enhancement request. The status of the issue will be updated here in GitHub.

Regards,
Iliana

@IlianaB IlianaB removed their assignment Aug 23, 2021
@jdichev
Copy link
Contributor

jdichev commented Aug 27, 2021

Hello @mocsa,

We have opened a task to iterate on your feedback involving our design counterparts.

Thanks for your feedback.

Best regards,
Jordan

@flovogt
Copy link
Member

flovogt commented Mar 24, 2022

This issue is covered in backlog item BGSOFUIPIRIN-5417.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants