We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
I would find it useful to have type restrictions reflected in the method signatures shown in the documentation. When I read
attach!(mechanism, predecessor, successor, joint; joint_pose, successor_pose)
I'm finding it hard to know what types are expected for all arguments. Something like
attach!(mechanism::Mechanism, predecessor::RigidBody, successor::RigidBody, joint::Joint; joint_pose::Transform3D, successor_pose::Transform3D)
would certainly help.
Since this package is already using DocStringExtensions, perhaps this could be accomplished by simply changing
$(SIGNATURES)
to
$(TYPEDSIGNATURES)
https://juliadocs.github.io/DocStringExtensions.jl/latest/#DocStringExtensions.TYPEDSIGNATURES
The text was updated successfully, but these errors were encountered:
No branches or pull requests
I would find it useful to have type restrictions reflected in the method signatures shown in the documentation. When I read
attach!(mechanism, predecessor, successor, joint; joint_pose, successor_pose)
I'm finding it hard to know what types are expected for all arguments. Something like
would certainly help.
Since this package is already using DocStringExtensions, perhaps this could be accomplished by simply changing
to
https://juliadocs.github.io/DocStringExtensions.jl/latest/#DocStringExtensions.TYPEDSIGNATURES
The text was updated successfully, but these errors were encountered: