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

Consolidate DESCRIPTION.rst and README.md #300

Open
leofang opened this issue Dec 13, 2024 · 3 comments
Open

Consolidate DESCRIPTION.rst and README.md #300

leofang opened this issue Dec 13, 2024 · 3 comments
Assignees
Labels
cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do

Comments

@leofang
Copy link
Member

leofang commented Dec 13, 2024

Indeed we're duplicating some of the information. It might take a few iterations to consolidate the two files and have something presentable on both PyPI and GitHub. Let's address this in the next release.

Originally posted by @leofang in #296 (comment)

@leofang leofang added this to the cuda.core beta 3 milestone Dec 13, 2024
@leofang leofang added documentation Improvements or additions to documentation P1 Medium priority - Should do cuda.core Everything related to the cuda.core module labels Dec 13, 2024
@vzhurba01
Copy link
Collaborator

I'd like to extend the scope of this issue to help consolidate/organize all the README.md and DESCRIPTION.rst between cuda-python, cuda.bindings and cuda.core. When resolving issue #297 with PR 397 I found that cuda.bindings also has awkwardness in creating a consolidated file that is presentable on both PyPI and GitHub.

For PyPI, it seems like we'd want:

  • To direct users to documentation
  • Runtime dependencies
  • Installing? (Perhaps a link to installing page in documentation is better)

For GitHub:

  • Same as PyPI
  • Development info
  • Running tests, samples and benchmarks

There's some overlap in dev info across subpackages that may belong better under cuda-python:

  • Code Linting
  • Code Signing
  • Supported Python Versions

In conclusion, info that applies to all subpackages should be under cuda-python while development info specific to a subpackage should be kept out of PyPI.

@vzhurba01 vzhurba01 added the cuda.bindings Everything related to the cuda.bindings module label Jan 15, 2025
@leofang
Copy link
Member Author

leofang commented Jan 15, 2025

Sounds like a plan! You have earned the title "trusted assignee," Vlad 👍

@leofang
Copy link
Member Author

leofang commented Jan 15, 2025

cc @rwgk for vis

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do
Projects
None yet
Development

No branches or pull requests

2 participants