You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If mypackage._submodule.PublicClass is not documented, then the reference in the signature won't resolve and readers can't click though to the definition of the class. Ideally mypackage.func would be documented as follows so that the reference to PublicClass is resolved and is therefore a clickable link:
deffunc(a: mypackage.PublicClass) ->bool:
...
The text was updated successfully, but these errors were encountered:
Here is an example scenario:
In this scenario, AutoAPI currently documents
mypackage.func
as the following:If
mypackage._submodule.PublicClass
is not documented, then the reference in the signature won't resolve and readers can't click though to the definition of the class. Ideallymypackage.func
would be documented as follows so that the reference toPublicClass
is resolved and is therefore a clickable link:The text was updated successfully, but these errors were encountered: