Fix D401 and D404 checks not working for docstrings containing only one word and ending with non-alpha character (#421) #422
Conversation
…ne word and ending with non-alpha character (#421)
src/pydocstyle/utils.py
Outdated
| def strip_non_alphanumeric(string: str) -> str: | ||
| """Strip string from any non-alphanumeric characters.""" | ||
| pattern = re.compile(r'[\W_]+') |
There was a problem hiding this comment.
It doesn't make sense to do the compilation inside the function definition. You won't benefit from doing a compile. I would move the compile outside, so that it's done only once.
There was a problem hiding this comment.
Done. Sorry for long response time, I was on vacation.
…_non_alphanumeric function. (#421)
|
To be honest, I'm not sure I like this change. The first line of a docstring should be a proper sentence that describes the function / class, and I don't see how one word, imperative of not, can qualify as a meaningful description. Happy to hear your thoughts on the subject. Perhaps we can add an issue that the first line should be > 1 word anyway? |
|
Without my changes if you add any non-alpha character after the first word, like comma, D401 and D404 will also not work properly, so my fix should be added anyway, even if you decide that one-word documentations should not be considered vaild. |
|
Good point, merging. |
No description provided.