-
Notifications
You must be signed in to change notification settings - Fork 9
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
Incorrect display of function/class argument types in documentation. #262
Comments
Possible solution: Create a python file with the following contents and add to sphinx project: `# sphinx_initvar_filter.py logger = logging.getLogger(name) class InitVarFilterDocumenter(ClassDocumenter):
def setup(app): Then modify conf.py to include the custom operation: `# conf.py autodoc_typehints = "description" |
Hasn't been tried and tested yet |
I suspect this might be linked in to the state of our Lines 91 to 143 in 84e005d
|
Nice find. is there a simple way to build the docs locally to test the changes? |
Should be able just to do |
It does work for me. |
Hm, I tried adding
to |
Describe the bug
Incorrect display of function/class argument types in documentation.
Expected behavior
I would expect to just see a display of arguments with a simple type e.g. my function(arg1: NDArray)
Screenshots
Desktop (please complete the following information):
Additional context
Add any other context about the problem here.
The text was updated successfully, but these errors were encountered: