search

uxlfoundation / oneAPI-spec

oneAPI Specification source files
https://spec.oneapi.com
Other
185 stars 107 forks source link

[oneMKL][Sparse BLAS] Misleading missing text in dark mode in `set_matrix_property` page #588

Open gajanan-choudhary opened 6 days ago

gajanan-choudhary commented 6 days ago

The sparse::set_matrix_property page in the oneMKL Specification appears to be rendered incorrectly in dark mode. See the rendered HTML link.

Here's the light mode view: image

and here's the dark mode view: image

and here's the dark mode view with text selected (showing text is present, but just appears hidden, maybe the color is off?): image

Rbiessy commented 6 days ago

Good catch, I didn't notice it. Pinging @rscohn2 since he mentioned he was planning to look into this kind of issues.

I can reproduce this issue locally. It looks like the issue is due to the new lines using | inside the table. I find it useful to describe the behavior of the property for each format. Maybe we should change this to have a subsection for every property (symmetric, sorted, etc) and inside a table for each format (CSR, COO, etc) if needed? That could make more sense once we support more matrices formats.

Rbiessy commented 6 days ago

Note that I reported another issue directly to Robert. In the provisional spec the Data handles page does not have an arrow on the left to deploy the children pages like init_dense_vector. I can't reproduce that issue locally unfortunately.

rscohn2 commented 5 days ago

In the provisional spec the Data handles page does not have an arrow on the left to deploy the children pages like init_dense_vector

It is controlled by https://github.com/uxlfoundation/oneAPI-spec/blob/6ad4cc5024236f455e9fa9bc00a7a110b8215694/source/index.rst?plain=1#L19

There is 1 extra level of nesting in the full spec versus onemkl standalone. I could make the full spec 4 so they render the same. Unlimited causes rendering problems.

I don't know what to do about the rendering problem in the table.

Rbiessy commented 5 days ago

Thanks, increasing the maxdepth to 4 sounds good to me.

I'll just avoid the new lines in tables and push it in https://github.com/uxlfoundation/oneAPI-spec/pull/583

Rbiessy commented 21 minutes ago

There is 1 extra level of nesting in the full spec versus onemkl standalone. I could make the full spec 4 so they render the same. Unlimited causes rendering problems.

@rscohn2 just making sure, are you planning to look into this issue before the 1.4 spec is out?