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

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

Closed
gajanan-choudhary opened this issue Sep 25, 2024 · 6 comments
Labels
documentation Improvements or additions to documentation MKL

Comments

@gajanan-choudhary
Copy link
Contributor

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

@gajanan-choudhary gajanan-choudhary added documentation Improvements or additions to documentation MKL labels Sep 25, 2024
@Rbiessy
Copy link
Contributor

Rbiessy commented Sep 26, 2024

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
Copy link
Contributor

Rbiessy commented Sep 26, 2024

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
Copy link
Member

rscohn2 commented Sep 26, 2024

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

:maxdepth: 3

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
Copy link
Contributor

Rbiessy commented Sep 26, 2024

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

I'll just avoid the new lines in tables and push it in #583

@Rbiessy
Copy link
Contributor

Rbiessy commented Oct 2, 2024

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?

@Rbiessy
Copy link
Contributor

Rbiessy commented Oct 23, 2024

The dark mode now renders correctly so closing this issue.
Created #598 to continue the discussion with the navigation tree.

@Rbiessy Rbiessy closed this as completed Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation MKL
Projects
None yet
Development

No branches or pull requests

3 participants