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.

Sign up for GitHub

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

Jump to bottom

Update docs #144

Merged
merged 10 commits into from
Oct 4, 2024
Merged

Update docs #144

merged 10 commits into from
Oct 4, 2024

Conversation

yasahi-hpc
Copy link
Collaborator

@yasahi-hpc yasahi-hpc commented Oct 1, 2024 •
edited
Loading

Resolves #48
This PR aims at improving the documentation.
Following changes are made.

  • Add explanations for default arguments rather than just saying it is optional
  • Add a link to unmanaged view example introduced in Implemented passing unmanaged views #101
  • Claim that runtime errors are all given with C++ std::runtime_error (not assertion)
  • Add explanation about the meanings of axes which may be non-trivial for non-python users

@yasahi-hpc yasahi-hpc self-assigned this Oct 1, 2024
@yasahi-hpc yasahi-hpc added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 1, 2024
@yasahi-hpc yasahi-hpc requested a review from tpadioleau October 1, 2024 13:07
tpadioleau
tpadioleau previously approved these changes Oct 1, 2024
View reviewed changes
Copy link
Member

@tpadioleau tpadioleau left a comment

Choose a reason for hiding this comment

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

LGTM

docs/intro/using.rst Outdated Show resolved Hide resolved
@yasahi-hpc yasahi-hpc requested a review from tpadioleau October 1, 2024 14:25
cedricchevalier19
cedricchevalier19 reviewed Oct 4, 2024
View reviewed changes
Copy link
Member

@cedricchevalier19 cedricchevalier19 left a comment

Choose a reason for hiding this comment

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

Looks better.

common/src/KokkosFFT_Helpers.hpp Outdated Show resolved Hide resolved
common/src/KokkosFFT_Helpers.hpp Outdated Show resolved Hide resolved
docs/intro/using.rst Show resolved Hide resolved
acalloo
acalloo reviewed Oct 4, 2024
View reviewed changes
docs/intro/using.rst Outdated Show resolved Hide resolved
@yasahi-hpc yasahi-hpc merged commit 545dc69 into main Oct 4, 2024
17 checks passed
@yasahi-hpc yasahi-hpc deleted the update-docs branch October 4, 2024 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tpadioleau tpadioleau tpadioleau left review comments

@cedricchevalier19 cedricchevalier19 cedricchevalier19 left review comments

@acalloo acalloo acalloo approved these changes

Assignees

@yasahi-hpc yasahi-hpc

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Review docs
4 participants
@yasahi-hpc @cedricchevalier19 @tpadioleau @acalloo