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

core(view): changes due to conversion from md to rst #571

Merged
merged 1 commit into from
Aug 28, 2024

Conversation

romintomasetti
Copy link
Contributor

As mentioned in #569, I'll need the View.md to understand RST. So I need to renamed it. And so Sphinx complains.

Changes:

  1. Sections, subsections and so on.
  2. Code blocks.
  3. References (to sections, footnote).
  4. Italic.
  5. The table becomes a csv-table.

@romintomasetti romintomasetti self-assigned this Aug 28, 2024
@romintomasetti
Copy link
Contributor Author

romintomasetti commented Aug 28, 2024

@dalg24 @masterleinad The diff is still hard to read, even though I went over the Sphinx complains one by one (nothing more). What should we do ?

  1. We don't care and proceed.
  2. I do one commit per type of change (see description), so the PR diff will still be bad, but each separate commit will be more reviewable.

Copy link
Contributor

@masterleinad masterleinad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Ignoring white space changes makes this not that hard to compare.

@dalg24
Copy link
Member

dalg24 commented Aug 28, 2024

Did you check that the output looks reasonable?

@masterleinad
Copy link
Contributor

The documentation in the artifact looked fine to me. We could try to improve the accessibility matrix a bit and reference_is_lvalue should be reference_type_is_lvalue but we can address that in a follow-up since it's preexisting.

@dalg24 dalg24 merged commit 6012f48 into kokkos:main Aug 28, 2024
2 checks passed
@romintomasetti romintomasetti deleted the view-md-to-rst branch August 28, 2024 13:53
romintomasetti added a commit to romintomasetti/kokkos-core-wiki that referenced this pull request Aug 28, 2024
This is a followup of kokkos#571.
masterleinad pushed a commit that referenced this pull request Aug 28, 2024
This is a followup of #571.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants