add a setting to enable / disable the numpy type preprocessor

[keewis]

Feature or Bugfix

• Bugfix

Purpose

This adds the napoleon_preprocess_types setting (could also be napoleon_preprocess_numpy_types or napoleon_link_types / napoleon_link_numpy_types) that controls whether the preprocessor is run. Defaults to True for now.

Relates

• closes Warning: Inline literal start-string without end-string in Numpy style Parameters section #8088

[keewis]

@tk0miya, I think the only issues left are the naming and the default value. I'm not sure about both, but I guess making the preprocessor opt-in would make the migration smoother.

[tk0miya]

I think the only issues left are the naming and the default value. I'm not sure about both, but I guess making the preprocessor opt-in would make the migration smoother.

+1 for the naming. Let's go with this.

About the default value, I'm still debating. It might be better to make disabled it by default if many projects uses types like type-hints. And it will be enabled after we'll support them in the future release. But I don't know how many projects do that. What do you think?

[keewis]

I don't know how many projects are using type hints instead of numpydoc type specs, either, and the projects I'm working on seem to consider type hints less readable than the type specs, but I agree that it might be better to make the type preprocessor opt-in for now. That way people can decide when they want to migrate (since version pinning does not always work, and people might also want some other new feature first).

[keewis]

I changed the default to False, but I'm not sure if I got the tests right (the question I have been asking myself is whether it would be better to update the setting or expected ).

Edit: would you consider this a breaking change?

[tk0miya]

Thank you for your update. I don't think this is a breaking change. The numpy type spec has been just released last week. So this does not harm anybody, I believe. Let's enable it after enough matured.