Skip to content

Add a !docs command #13

@Andre601

Description

@Andre601

The Discord could really benefit from Clippy having a !docs command

This command would essentially search the LuckPerms Javadoc for the provided info and returns whatever it can find for it.


Example

Running !docs NodeAddEvent#getNode() would give the below output (as Embed)

@NonNull NodeAddEvent#getNode() : Node
Gets the node that was added

Returns:
The node that was added


Issues/Downsides

The Javadocs are built agains Java 8.
This comes with the issue, that the URL won't reflect the current class/method being selected.
For example, would the above example still display the URL as https://javadoc.io/doc/net.luckperms/api/latest/index.html while it should preferably display as https://javadoc.io/doc/net.luckperms/api/latest/net/luckperms/api/event/node/NodeAddEvent.html#getNode() since this is a more reliable and shareable link.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions