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 spell checker #161

Open
kevinsung opened this issue May 3, 2024 · 2 comments
Open

Add spell checker #161

kevinsung opened this issue May 3, 2024 · 2 comments
Labels
good first issue Good for newcomers

Comments

@kevinsung
Copy link
Collaborator

kevinsung commented May 3, 2024

The spell checker checks for spelling errors in comments and docstrings and should run in CI. It looks like Qiskit uses pylint to enforce spelling: https://github.com/Qiskit/qiskit/blob/dcd41e9fcedd6f51fe725c25c4ed583c22bb3525/pyproject.toml#L241

We don't use pylint here though, so we should explore other options. This issue might have some leads: astral-sh/ruff#1628.

@kevinsung kevinsung added the good first issue Good for newcomers label Jul 15, 2024
@boonware
Copy link

@kevinsung Can you provide information on what is needed here? As this is marked as a good first issues for newcomers, it would be helpful to have details.

@kevinsung
Copy link
Collaborator Author

@kevinsung Can you provide information on what is needed here? As this is marked as a good first issues for newcomers, it would be helpful to have details.

I've added some details to the opening post.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants