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

Add documentation for CPM usage #1600

Merged
merged 4 commits into from
Jul 22, 2024
Merged

Conversation

pauleonix
Copy link
Contributor

Description

  • Add section in README.md that describes issue with CPM's single argument syntax.
  • Update link to CPM.cmake repo (old link redirected to this new one).
  • Add optional INTERFACE argument to CMake snippets for completeness.

closes #1594

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

Copy link

copy-pr-bot bot commented Jul 2, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Copy link
Member

@harrism harrism left a comment

Choose a reason for hiding this comment

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

Looks great. Thank you!

@harrism harrism added doc Documentation non-breaking Non-breaking change labels Jul 2, 2024
@harrism
Copy link
Member

harrism commented Jul 2, 2024

/ok to test

@harrism harrism requested a review from robertmaynard July 2, 2024 20:56
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
- Add section in README.md that describes issue with CPM's single argument syntax.
- Update link to CPM.cmake repo (old link redirected to this new one).
- Add optional INTERFACE argument to CMake snippets for completeness.

Co-authored-by: Robert Maynard <[email protected]>
@harrism
Copy link
Member

harrism commented Jul 3, 2024

Instead of rebasing and force pushing, for PR branches you should merge. Force pushing disassociates github comments from the code, so we discourage it in RAPIDS. Thanks!

@pauleonix
Copy link
Contributor Author

pauleonix commented Jul 12, 2024

@harrism Thanks for the feedback! I was seduced by the possibility to just amend my previous commit instead of creating a new one. I wasn't aware of the problem regarding comments here on GitHub. I really need to stop overthinking adding small commits 😅

Is the CI broken?

@wence-
Copy link
Contributor

wence- commented Jul 12, 2024

/ok to test

@wence-
Copy link
Contributor

wence- commented Jul 12, 2024

Is the CI broken?

No, but we must authorise in case you are doing anything nefarious

@pauleonix
Copy link
Contributor Author

Fixed the spelling error that triggered codespell.

@vyasr
Copy link
Contributor

vyasr commented Jul 15, 2024

/ok to test

@harrism
Copy link
Member

harrism commented Jul 22, 2024

/ok to test

README.md Outdated Show resolved Hide resolved
@harrism
Copy link
Member

harrism commented Jul 22, 2024

/ok to test

@harrism
Copy link
Member

harrism commented Jul 22, 2024

/merge

@rapids-bot rapids-bot bot merged commit 0e7d519 into rapidsai:branch-24.08 Jul 22, 2024
61 checks passed
@pauleonix pauleonix deleted the patch-2 branch July 22, 2024 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation for usage with CPM
5 participants