chore: fix inclusive naming in certificates docstring library#381
Open
chore: fix inclusive naming in certificates docstring library#381
Conversation
This `Dummy` word fails the automatic inclusive naming check and hurts our CI :) Could we fix this?
Contributor
tonyandrewmeyer
left a comment
There was a problem hiding this comment.
Perhaps we should take this opportunity to do this more thoroughly?
$ rg -i dummy -c
interfaces/s3/interface/v1/interface.yaml:1
interfaces/tls-certificates/tests/unit/dummy_provider_charm/charmcraft.yaml:2
interfaces/tls-certificates/tests/unit/dummy_requirer_charm/charmcraft.yaml:2
interfaces/tls-certificates/tests/unit/dummy_provider_charm/src/charm.py:2
interfaces/tls-certificates/tests/unit/dummy_requirer_charm/src/charm.py:5
interfaces/tls-certificates/tests/unit/test_requires.py:23
interfaces/certificate_transfer/tests/unit/test_certificate_transfer_provides_v1.py:2
interfaces/certificate_transfer/tests/unit/test_certificate_transfer_requires_v1.py:2
interfaces/tls-certificates/tests/integration/charms/provider/charm.py:2
interfaces/certificate_transfer/src/charmlibs/interfaces/certificate_transfer/__init__.py:4
interfaces/tls-certificates/tests/integration/charms/requirer/charm.py:2
interfaces/tls-certificates/tests/unit/test_provides.py:3
snap/tests/unit/test_snap.py:3
interfaces/k8s_backup_target/tests/unit/test_backup_target.py:6
pathops/tests/unit/conftest.py:2
pathops/tests/functional/conftest.py:2
Contributor
I'm curious how the docstring of a PyPI package hits your CI. Does your language check look through all your dependencies? Via the packed charm artifact perhaps? Do you have this library vendored into your repository? |
Author
|
Why not! We hit this problem with the vendored charm library version of the TLS library, it wouldn't trigger for the PyPI version; I thought I would open the PR here regardless though, since if at some point some check of the same kind runs on this repository, we don't wanna hit the problem again :) |
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.
This
Dummyword fails the automatic inclusive naming check and hurts our CI :) Could we fix this?