Skip to content

Conversation

@AviralGoelAMD
Copy link
Collaborator

@AviralGoelAMD AviralGoelAMD commented Apr 11, 2025

Proposed changes

This PR adds doxygen generated documentation for the ck_tile::array<T,N> container.

Checklist

Please put an x into the boxes that apply. You can also fill these out after creating the PR. If you're not sure, please don't hesitate to ask.

  • I have added tests relevant to the introduced functionality, and the unit tests are passing locally
  • I have added the test to REGRESSION_TESTS list defined at the top of CMakeLists.txt in tests/CMakeLists.txt, IF the test takes more than 30 seconds to run.
  • I have added inline documentation which enables the maintainers with understanding the motivation
  • I have removed the stale documentation which is no longer relevant after this pull request
  • (If this change is user-facing) I have added release notes which provide the end users with a brief summary of the improvement from this pull request
  • I have run clang-format on all changed files
  • Any dependent changes have been merged

Discussion

If this is a relatively large or complex change, feel free to start a discussion by explaining why you chose the solution you did and what alternatives you considered

bartekxk
bartekxk previously approved these changes Apr 14, 2025
Copy link
Collaborator

@aosewski aosewski left a comment

Choose a reason for hiding this comment

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

Just few spellings.

Co-authored-by: Adam Osewski <[email protected]>
Co-authored-by: Adam Osewski <[email protected]>
Copy link
Contributor

@spolifroni-amd spolifroni-amd left a comment

Choose a reason for hiding this comment

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

minor changes

@afagaj afagaj changed the title addded documentation for ck_tile::array<T,N> Add documentation for ck_tile::array<T,N> Apr 14, 2025
@AviralGoelAMD
Copy link
Collaborator Author

reverted documentation to use the term "punning" instead of "pruning".

Copy link
Collaborator Author

@AviralGoelAMD AviralGoelAMD left a comment

Choose a reason for hiding this comment

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

fixed terms

Copy link
Contributor

@ThomasNing ThomasNing left a comment

Choose a reason for hiding this comment

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

LGTM

@ThomasNing ThomasNing dismissed spolifroni-amd’s stale review April 30, 2025 23:43

Addressed the comments

@ThomasNing ThomasNing merged commit 1d8ef40 into develop Apr 30, 2025
34 of 38 checks passed
@afagaj afagaj deleted the add_docs branch May 1, 2025 04:36
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants