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

typed signatures in documentation #624

Open
baggepinnen opened this issue Sep 3, 2021 · 0 comments
Open

typed signatures in documentation #624

baggepinnen opened this issue Sep 3, 2021 · 0 comments

Comments

@baggepinnen
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant