Skip to content

rustdoc documentation pattern of "set_foo() /// sets foo" #480

Open
@kornelski

Description

@kornelski

The documentation of setters is quite terse and does not add information that isn't already in the function name.

As a fresh new user, I'm still unfamiliar with the conventions and terminology of this crate, so the docs.rs documentation is unhelpful to me.

For methods like set_friction and set_restitution I'd like to know what's the expected range of values and what are the consequences of setting them.

Also "restitution" is a quite technical term. It would be helpful if the docs explained what it means or linked to the website for more explanation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions