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

pyproject metadata updates, and minor docs fix #1921

Merged
merged 1 commit into from
Mar 14, 2024
Merged

Conversation

kounelisagis
Copy link
Member

Fixes readinto() description for the docs and moves more metadata into pyproject.toml.

@kounelisagis kounelisagis requested a review from dudoslav March 14, 2024 14:22
@kounelisagis kounelisagis marked this pull request as ready for review March 14, 2024 14:22
Copy link
Collaborator

@dudoslav dudoslav left a comment

Choose a reason for hiding this comment

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

I am getting lost in what file is used for building this repo. Is it setup.py or pyproject.toml? Or both and it is then combined? What would happen if setup.py would define the same variables as pyproject.toml? like version_scheme for example.

@kounelisagis
Copy link
Member Author

I'm trying to move everything to .toml. Some things depend on Python functions, so it's more complex.


"While it is not technically necessary yet, it is STRONGLY RECOMMENDED for a project to have a pyproject.toml file at the root of its source tree"
"One way to look at it is that the scope of setuptools has now been reduced to the role of a build backend."
https://packaging.python.org/en/latest/guides/modernize-setup-py-project/#modernize-setup-py-project

@dudoslav
Copy link
Collaborator

I would recommend to also get @ihnorton 's approval.

@kounelisagis kounelisagis merged commit 5cfefdd into dev Mar 14, 2024
28 checks passed
@kounelisagis kounelisagis deleted the agis/minor-fix-docs branch March 14, 2024 15:13
Copy link
Member

@ihnorton ihnorton left a comment

Choose a reason for hiding this comment

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

Small doc changes are fine to merge with ✅ from anyone. Just make sure to put build system change in the title too in order to get attention on the scope of the change - ie I would suggest titling this PR something like "pyproject metadata updates, and minor docs fix".

@kounelisagis kounelisagis changed the title Minor fix docs pyproject metadata updates, and minor docs fix Mar 14, 2024
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