-
Notifications
You must be signed in to change notification settings - Fork 36
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
Packages names sometimes required #284
Comments
Not sure I understand that "algorithm", did you mean "isn't"? If so, I think that would be way too noisy. Intuitively, I would only generate the fully qualified name when two or more unqualified type names are identical within a signature. |
I don't think it's a matter of conflict : if you are in package h2d which has already an Object class but a variable reference a h3d.scene.Object, it should not be listed as Object. But I agree we should not be explicit for every out-of-package path. So my proposal is to do it IF the type name is already used in current package (or any parent package, including root package). |
You could have this exact same problem independent of what the current / parent package is though. Say you have a method |
Both are complementary. Another way is to use your approach, but instead of per signature, at the level of the whole type definition. I guess that would work too, as long as you don't see "Object" which changes meaning depending on the signature: For example:
|
https://heaps.io/api/h2d/ObjectFollower.html#new
The constructor is generated as
new(obj:Object, ?parent:Object)
but its real type isnew(obj:h3d.scene.Object, ?parent:h2d.Object)
I think we should generate explicit package name in documentation when there is such a class in the current (or parent) package. That should also fix for instance someone having a
pack.Array
class being documented asArray
and thus creating confusion.The text was updated successfully, but these errors were encountered: