Skip to content
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

Signature of interfaces not propagated to the documentation API #147

Closed
h-mayorquin opened this issue Sep 8, 2022 · 0 comments · Fixed by #150
Closed

Signature of interfaces not propagated to the documentation API #147

h-mayorquin opened this issue Sep 8, 2022 · 0 comments · Fixed by #150

Comments

@h-mayorquin
Copy link
Contributor

h-mayorquin commented Sep 8, 2022

So, for the interfaces we only get this for the function signature:

image

See here for more examples:
https://neuroconv.readthedocs.io/en/main/api/interfaces.html

As this is a problem only for interfaces I suspect it might be an issue arising from the new magic for overriding their interfaces attributes here:

class _LazyExtractorImport(type(BaseDataInterface), type):
def __getattribute__(self, name):
if name == "Extractor" and super().__getattribute__("Extractor") is None:
extractor_module = get_package(package_name=super().__getattribute__("ExtractorModuleName"))
extractor = getattr(
extractor_module,
super().__getattribute__("ExtractorName") or self.__name__.replace("Interface", "Extractor"),
)
return extractor
return super().__getattribute__(name)

@h-mayorquin h-mayorquin changed the title Parameters of interfaces not propagated to the documentation API Signature of interfaces not propagated to the documentation API Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant