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

ament_pep257 uses deprecated pydocstyle #497

Open
InvincibleRMC opened this issue Jul 25, 2024 · 1 comment
Open

ament_pep257 uses deprecated pydocstyle #497

InvincibleRMC opened this issue Jul 25, 2024 · 1 comment
Labels
backlog help wanted Extra attention is needed

Comments

@InvincibleRMC
Copy link

It currently still works but has been deprecated in favor of ruff. However as of astral-sh/ruff#659 there is not currently a Python api that could be used to replace it. And even if it did work ruff is not available via package managers yet.

Some possible solutions are the following:

  1. Add warning into ament_pep257 that it might break in the future
  2. Hold out for a ruff api replacement that could be dropped in pydocstyles' place in the future
  3. Add a deprecation warning then in some future version deprecate in favor of some future ament_ruff
@mjcarroll
Copy link
Contributor

While ruff is interesting, as you mentioned there isn't a Python API that makes it readily available to be used.

When discussing in the weekly maintenance triage, it was also pointed out that flake8 also likely covers most of what we need from pep257.

In the short term, a pull request adding a deprecation warning for ament_pep257 (option 3) would be acceptable. Thanks for bringing this up.

@mjcarroll mjcarroll added help wanted Extra attention is needed backlog labels Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants