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

Borked styling of list items under /register definition #1352

Closed
DMRobertson opened this issue Nov 17, 2022 · 3 comments · Fixed by #1446
Closed

Borked styling of list items under /register definition #1352

DMRobertson opened this issue Nov 17, 2022 · 3 comments · Fixed by #1446
Labels
aesthetic A suggestion or issue relating to the representation of the spec

Comments

@DMRobertson
Copy link
Contributor

Link to problem area: https://spec.matrix.org/v1.4/client-server-api/#post_matrixclientv3register

Issue
image

Was fine in 1.3, borked in 1.4 and 1.5.

@DMRobertson DMRobertson added the aesthetic A suggestion or issue relating to the representation of the spec label Nov 17, 2022
@richvdh
Copy link
Member

richvdh commented Feb 21, 2023

This seems to have been caused by 473b30b. The intention was to move the expander arrow on the summary section itself, but it has also had an effect on lists within the summary.

@DMRobertson
Copy link
Contributor Author

If it was up to me I'd just make the summary hold the POST /_matrix/foo/v1/bar/ and nothing else. I usually minimise an endpoint's description if I don't care about it and want to see the rest of the document. Put differently: I think a <summary> whose height is about that of the viewport is excessive!

@richvdh
Copy link
Member

richvdh commented Feb 22, 2023

If it was up to me I'd just make the summary hold the POST /_matrix/foo/v1/bar/ and nothing else. I usually minimise an endpoint's description if I don't care about it and want to see the rest of the document. Put differently: I think a <summary> whose height is about that of the viewport is excessive!

I think this is an easy change in https://github.com/matrix-org/matrix-spec/blob/main/layouts/partials/openapi/render-operation.html, if anyone fancies giving it a go! You might end up having to muck about with the CSS though.

richvdh pushed a commit that referenced this issue May 30, 2023
I previously made this change for HTTP endpoints in #1446. It seems there are
other places where we have over-sized `<summary>` elements. I would like
to elimintate those too, as grumbled about in
#1358 (comment)
and
#1352 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aesthetic A suggestion or issue relating to the representation of the spec
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants