Argument of type "None" cannot be assigned to parameter "stop_words" of type "str | List[str]" in function "extract_keywords"

[VictorCrd]

Small warning between the documentation and the code implementation (nothing serious)

With the bellow code I have a warning:
Argument of type "None" cannot be assigned to parameter "stop_words" of type "str | List[str]" in function "extract_keywords"
Type "None" is not assignable to type "str | List[str]"
"None" is not assignable to "str"
"None" is not assignable to "List[str]"

sim = kw_model.extract_keywords(text,
                                keyphrase_ngram_range=(1, 1), 
                                stop_words=None,
                                vectorizer=vectorizer,
                                top_n=list_words.__len__())

I'm not sure this is intended, as in the following example in the documentation, stop_words is None.

>>> kw_model.extract_keywords(doc, keyphrase_ngram_range=(1, 1), stop_words=None)
[('learning', 0.4604),
 ('algorithm', 0.4556),
 ('training', 0.4487),
 ('class', 0.4086),
 ('mapping', 0.3700)]

So should the documentation or code be changed?

[MaartenGr]

You can use stop_words=None here without any problems. Most likely the warning that you are getting is because of some type checking that is being done on your end. The type hint of stop_words is:

stop_words: Union[str, List[str]] = "english"

which suggest that None is not an option, although it is. Most likely, the type hinting should be updated here but it shouldn't affect the code/usability of KeyBERT. Sort of a code-documentation issue.

[VictorCrd]

Indeed, it works well with None (I've left room for doubt in case this wasn't intended)
In any case, as you say, it's a question of documentation rather than a "bug".