Closed
Conversation
mberz
approved these changes
Jan 8, 2025
mberz
requested changes
Jan 8, 2025
Member
mberz
left a comment
mberz
left a comment
There was a problem hiding this comment.
Apart from the deleted notebook all good
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR applies a Cookiecutter refactoring that modernizes the packaging, documentation, and CI configurations for the pyrato project while addressing naming and formatting consistency.
- Removed the legacy setup.py file in favor of pyproject.toml for packaging.
- Updated documentation and internal references from “pyfar” to “pyrato.”
- Revised CI configurations and dependency specifications, including updates to Python versions and installation commands.
Reviewed Changes
Copilot reviewed 10 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| setup.py | Removed legacy packaging script in favor of a modern pyproject.toml configuration. |
| pyrato/dsp.py | Minor docstring formatting adjustments. |
| pyrato/analytic/analytic.py | Docstring improvements including changes to parameter formatting and citations. |
| pyrato/init.py | Moved and streamlined top-level package metadata and docstrings. |
| pyproject.toml | Added comprehensive project metadata, dependency, and linting configurations. |
| docs/conf.py | Updated hard-coded links from “pyfar” to “pyrato.” |
| .readthedocs.yml | Adjusted Python version and documentation installation method. |
| .github/ISSUE_TEMPLATE.md | Updated package name to maintain consistency. |
| .circleci/config.yml | Refined CI jobs by switching to pip install commands, updating Python versions, and cleaning up installation steps. |
Files not reviewed (5)
- CONTRIBUTING.rst: Language not supported
- docs/_static/css/custom.css: Language not supported
- docs/api_reference.rst: Language not supported
- requirements_dev.txt: Language not supported
- setup.cfg: Language not supported
Comments suppressed due to low confidence (1)
pyrato/analytic/analytic.py:33
- The reference marker '[#]' in the citation is ambiguous; consider using a numeric reference like '[1]' to clearly indicate the intended citation.
.. [#] H. Kuttruff, Room acoustics, pp. 64-66, 4th Ed. Taylor & Francis,
Member
Author
|
on hold due to #48 |
Member
Author
|
replaced by #48 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
note that ruff would fail, if the rules would be active